io.bloombox.schema.search.SearchResultOptionsOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-client Show documentation
Java RPCAPI client for the Bloombox Cloud.
The newest version!
/*
 * Copyright 2019, Momentum Ideas, Co. All rights reserved.
 *
 * Source and object computer code contained herein is the private intellectual
 * property of Momentum Ideas Co., a Delaware Corporation. Use of this
 * code in source form requires permission in writing before use or the
 * assembly, distribution, or publishing of derivative works, for commercial
 * purposes or any other purpose, from a duly authorized officer of Momentum
 * Ideas Co.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: search/SearchSpec.proto

package io.bloombox.schema.search;

public interface SearchResultOptionsOrBuilder extends
    // @@protoc_insertion_point(interface_extends:bloombox.search.SearchResultOptions)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * Only return matching keys - i.e. don't include other object data, like its name, description, or media asset links.
   * 
   *
   * bool keys_only = 1;
   */
  boolean getKeysOnly();

  /**
   *    * Enable result highlighting
   * 
   *
   * .bloombox.search.ResultHighlightMode highlight = 2;
   */
  int getHighlightValue();
  /**
   *    * Enable result highlighting
   * 
   *
   * .bloombox.search.ResultHighlightMode highlight = 2;
   */
  io.bloombox.schema.search.ResultHighlightMode getHighlight();

  /**
   *    * Specifies desired extensions to stock search result data.
   * 
   *
   * repeated .bloombox.search.SearchResultExtension include = 3;
   */
  java.util.List getIncludeList();
  /**
   *    * Specifies desired extensions to stock search result data.
   * 
   *
   * repeated .bloombox.search.SearchResultExtension include = 3;
   */
  int getIncludeCount();
  /**
   *    * Specifies desired extensions to stock search result data.
   * 
   *
   * repeated .bloombox.search.SearchResultExtension include = 3;
   */
  io.bloombox.schema.search.SearchResultExtension getInclude(int index);
  /**
   *    * Specifies desired extensions to stock search result data.
   * 
   *
   * repeated .bloombox.search.SearchResultExtension include = 3;
   */
  java.util.List
  getIncludeValueList();
  /**
   *    * Specifies desired extensions to stock search result data.
   * 
   *
   * repeated .bloombox.search.SearchResultExtension include = 3;
   */
  int getIncludeValue(int index);
}