Package com.google.ads.googleads.v23.services

Class SearchSettings.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<SearchSettings.Builder>
com.google.ads.googleads.v23.services.SearchSettings.Builder
All Implemented Interfaces:
SearchSettingsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchSettings
public static final class SearchSettings.Builder extends com.google.protobuf.GeneratedMessage.Builder<SearchSettings.Builder> implements SearchSettingsOrBuilder
 Indicates search settings in request parameter.
Protobuf type google.ads.googleads.v23.services.SearchSettings

  • Method Summary

    Modifier and Type
    Method
    Description
    SearchSettings
    build()
     
    SearchSettings
    buildPartial()
     
    SearchSettings.Builder
    clear()
     
    SearchSettings.Builder
    clearOmitResults()
    If true, results will be excluded from the response.
    SearchSettings.Builder
    clearReturnSummaryRow()
    If true, summary row will be included in the response and sent in a response by itself after all other query results are returned.
    SearchSettings.Builder
    clearReturnTotalResultsCount()
    If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response.
    SearchSettings
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    boolean
    getOmitResults()
    If true, results will be excluded from the response.
    boolean
    getReturnSummaryRow()
    If true, summary row will be included in the response and sent in a response by itself after all other query results are returned.
    boolean
    getReturnTotalResultsCount()
    If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    SearchSettings.Builder
    mergeFrom(SearchSettings other)
     
    SearchSettings.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    SearchSettings.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    SearchSettings.Builder
    setOmitResults(boolean value)
    If true, results will be excluded from the response.
    SearchSettings.Builder
    setReturnSummaryRow(boolean value)
    If true, summary row will be included in the response and sent in a response by itself after all other query results are returned.
    SearchSettings.Builder
    setReturnTotalResultsCount(boolean value)
    If true, the total number of results that match the query ignoring the LIMIT clause will be included in the response.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<SearchSettings.Builder>

    • clear

      public SearchSettings.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<SearchSettings.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<SearchSettings.Builder>

    • getDefaultInstanceForType

      public SearchSettings getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public SearchSettings build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public SearchSettings buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public SearchSettings.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchSettings.Builder>

    • mergeFrom

      public SearchSettings.Builder mergeFrom(SearchSettings other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<SearchSettings.Builder>

    • mergeFrom

      public SearchSettings.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchSettings.Builder>
      Throws:
      IOException

    • getOmitResults

      public boolean getOmitResults()
       If true, results will be excluded from the response. Otherwise, results
 will be returned.
 Default is false.
      bool omit_results = 1;
      Specified by:
      getOmitResults in interface SearchSettingsOrBuilder
      Returns:
      The omitResults.

    • setOmitResults

      public SearchSettings.Builder setOmitResults(boolean value)
       If true, results will be excluded from the response. Otherwise, results
 will be returned.
 Default is false.
      bool omit_results = 1;
      Parameters:
      value - The omitResults to set.
      Returns:
      This builder for chaining.

    • clearOmitResults

      public SearchSettings.Builder clearOmitResults()
       If true, results will be excluded from the response. Otherwise, results
 will be returned.
 Default is false.
      bool omit_results = 1;
      Returns:
      This builder for chaining.

    • getReturnSummaryRow

      public boolean getReturnSummaryRow()
       If true, summary row will be included in the response and sent in a
 response by itself after all other query results are returned.
 Default is false.
      bool return_summary_row = 2;
      Specified by:
      getReturnSummaryRow in interface SearchSettingsOrBuilder
      Returns:
      The returnSummaryRow.

    • setReturnSummaryRow

      public SearchSettings.Builder setReturnSummaryRow(boolean value)
       If true, summary row will be included in the response and sent in a
 response by itself after all other query results are returned.
 Default is false.
      bool return_summary_row = 2;
      Parameters:
      value - The returnSummaryRow to set.
      Returns:
      This builder for chaining.

    • clearReturnSummaryRow

      public SearchSettings.Builder clearReturnSummaryRow()
       If true, summary row will be included in the response and sent in a
 response by itself after all other query results are returned.
 Default is false.
      bool return_summary_row = 2;
      Returns:
      This builder for chaining.

    • getReturnTotalResultsCount

      public boolean getReturnTotalResultsCount()
       If true, the total number of results that match the query ignoring the
 LIMIT clause will be included in the response.
 Default is false.
      bool return_total_results_count = 3;
      Specified by:
      getReturnTotalResultsCount in interface SearchSettingsOrBuilder
      Returns:
      The returnTotalResultsCount.

    • setReturnTotalResultsCount

      public SearchSettings.Builder setReturnTotalResultsCount(boolean value)
       If true, the total number of results that match the query ignoring the
 LIMIT clause will be included in the response.
 Default is false.
      bool return_total_results_count = 3;
      Parameters:
      value - The returnTotalResultsCount to set.
      Returns:
      This builder for chaining.

    • clearReturnTotalResultsCount

      public SearchSettings.Builder clearReturnTotalResultsCount()
       If true, the total number of results that match the query ignoring the
 LIMIT clause will be included in the response.
 Default is false.
      bool return_total_results_count = 3;
      Returns:
      This builder for chaining.