Class ParentIdQueryBuilder

java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>
org.elasticsearch.join.query.ParentIdQueryBuilder
All Implemented Interfaces:
org.elasticsearch.common.io.stream.NamedWriteable, org.elasticsearch.common.io.stream.Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.index.query.QueryBuilder, org.elasticsearch.index.query.Rewriteable<org.elasticsearch.index.query.QueryBuilder>

public final class ParentIdQueryBuilder extends org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>
  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.ToXContent.Params

    Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

    org.elasticsearch.common.io.stream.Writeable.Reader<V extends Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends Object>
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static boolean
    The default value for ignore_unmapped.
    static String
     

    Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

    boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

    Fields inherited from interface org.elasticsearch.index.query.Rewriteable

    MAX_REWRITE_ROUNDS

    Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

    EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
     
    ParentIdQueryBuilder​(org.elasticsearch.common.io.stream.StreamInput in)
    Read from a stream.
  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
     
    protected int
     
    protected org.apache.lucene.search.Query
    doToQuery​(org.elasticsearch.index.query.SearchExecutionContext context)
     
    protected void
    doWriteTo​(org.elasticsearch.common.io.stream.StreamOutput out)
     
    protected void
    doXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
     
     
     
     
    boolean
    Gets whether the query builder will ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.
    ignoreUnmapped​(boolean ignoreUnmapped)
    Sets whether the query builder should ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.

    Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

    addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

    isFragment
  • Field Details

  • Constructor Details

    • ParentIdQueryBuilder

      public ParentIdQueryBuilder(String type, String id)
    • ParentIdQueryBuilder

      public ParentIdQueryBuilder(org.elasticsearch.common.io.stream.StreamInput in) throws IOException
      Read from a stream.
      Throws:
      IOException
  • Method Details

    • doWriteTo

      protected void doWriteTo(org.elasticsearch.common.io.stream.StreamOutput out) throws IOException
      Specified by:
      doWriteTo in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>
      Throws:
      IOException
    • getType

      public String getType()
    • getId

      public String getId()
    • ignoreUnmapped

      public ParentIdQueryBuilder ignoreUnmapped(boolean ignoreUnmapped)
      Sets whether the query builder should ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.
    • ignoreUnmapped

      public boolean ignoreUnmapped()
      Gets whether the query builder will ignore unmapped types (and run a MatchNoDocsQuery in place of this query) or throw an exception if the type is unmapped.
    • doXContent

      protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws IOException
      Specified by:
      doXContent in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>
      Throws:
      IOException
    • fromXContent

      public static ParentIdQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws IOException
      Throws:
      IOException
    • doToQuery

      protected org.apache.lucene.search.Query doToQuery(org.elasticsearch.index.query.SearchExecutionContext context) throws IOException
      Specified by:
      doToQuery in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>
      Throws:
      IOException
    • doEquals

      protected boolean doEquals(ParentIdQueryBuilder that)
      Specified by:
      doEquals in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>
    • doHashCode

      protected int doHashCode()
      Specified by:
      doHashCode in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>
    • getWriteableName

      public String getWriteableName()