Class GetRequest

    • Constructor Detail

      • GetRequest

        public GetRequest()
      • GetRequest

        public GetRequest​(java.lang.String index)
        Constructs a new get request against the specified index. The type(String) and id(String) must be set.
      • GetRequest

        public GetRequest​(java.lang.String index,
                          java.lang.String type,
                          java.lang.String id)
        Constructs a new get request against the specified index with the type and id.
        Parameters:
        index - The index to get the document from
        type - The type of the document
        id - The id of the document
    • Method Detail

      • type

        public GetRequest type​(@Nullable
                               java.lang.String type)
        Sets the type of the document to fetch.
      • id

        public GetRequest id​(java.lang.String id)
        Sets the id of the document to fetch.
      • parent

        public java.lang.String parent()
        Returns:
        The parent for this request.
      • parent

        public GetRequest parent​(java.lang.String parent)
        Sets the parent id of this document.
      • routing

        public GetRequest routing​(java.lang.String routing)
        Controls the shard routing of the request. Using this value to hash the shard and not the id.
      • preference

        public GetRequest preference​(java.lang.String preference)
        Sets the preference to execute the search. Defaults to randomize across shards. Can be set to _local to prefer local shards, _primary to execute only on primary shards, or a custom value, which guarantees that the same order will be used across different requests.
      • type

        public java.lang.String type()
      • id

        public java.lang.String id()
      • routing

        public java.lang.String routing()
      • preference

        public java.lang.String preference()
      • storedFields

        public GetRequest storedFields​(java.lang.String... fields)
        Explicitly specify the stored fields that will be returned. By default, the _source field will be returned.
      • storedFields

        public java.lang.String[] storedFields()
        Explicitly specify the stored fields that will be returned. By default, the _source field will be returned.
      • refresh

        public GetRequest refresh​(boolean refresh)
        Should a refresh be executed before this get operation causing the operation to return the latest value. Note, heavy get should not set this to true. Defaults to false.
      • refresh

        public boolean refresh()
      • realtime

        public boolean realtime()
      • realtime

        public GetRequest realtime​(boolean realtime)
        Specified by:
        realtime in interface RealtimeRequest
        Parameters:
        realtime - Controls whether this request should be realtime by reading from the translog.
      • version

        public long version()
        Sets the version, which will cause the get operation to only be performed if a matching version exists and no changes happened on the doc since then.
      • version

        public GetRequest version​(long version)
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object