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 java.lang.Object>, org.elasticsearch.common.io.stream.Writeable.Writer<V extends java.lang.Object>
  • Field Summary

    Fields
    Modifier and Type Field Description
    static boolean DEFAULT_IGNORE_UNMAPPED
    The default value for ignore_unmapped.
    static java.lang.String NAME  

    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​(java.lang.String type, java.lang.String id)  
    ParentIdQueryBuilder​(org.elasticsearch.common.io.stream.StreamInput in)
    Read from a stream.
  • Method Summary

    Modifier and Type Method Description
    protected boolean doEquals​(ParentIdQueryBuilder that)  
    protected int doHashCode()  
    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)  
    static ParentIdQueryBuilder fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    java.lang.String getId()  
    java.lang.String getType()  
    java.lang.String getWriteableName()  
    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.
    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.

    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

    • NAME

      public static final java.lang.String NAME
      See Also:
      Constant Field Values
    • DEFAULT_IGNORE_UNMAPPED

      public static final boolean DEFAULT_IGNORE_UNMAPPED
      The default value for ignore_unmapped.
      See Also:
      Constant Field Values
  • Constructor Details

    • ParentIdQueryBuilder

      public ParentIdQueryBuilder​(java.lang.String type, java.lang.String id)
    • ParentIdQueryBuilder

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

    • doWriteTo

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

      public java.lang.String getType()
    • getId

      public java.lang.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 java.io.IOException
      Specified by:
      doXContent in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>
      Throws:
      java.io.IOException
    • fromXContent

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

      protected org.apache.lucene.search.Query doToQuery​(org.elasticsearch.index.query.SearchExecutionContext context) throws java.io.IOException
      Specified by:
      doToQuery in class org.elasticsearch.index.query.AbstractQueryBuilder<ParentIdQueryBuilder>
      Throws:
      java.io.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 java.lang.String getWriteableName()