Package com.google.ads.googleads.v18.services

Class SearchGoogleAdsResponse.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder>
com.google.ads.googleads.v18.services.SearchGoogleAdsResponse.Builder
All Implemented Interfaces:
SearchGoogleAdsResponseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
SearchGoogleAdsResponse
public static final class SearchGoogleAdsResponse.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder> implements SearchGoogleAdsResponseOrBuilder
 Response message for
 [GoogleAdsService.Search][google.ads.googleads.v18.services.GoogleAdsService.Search].
Protobuf type google.ads.googleads.v18.services.SearchGoogleAdsResponse

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • clear

      public SearchGoogleAdsResponse.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.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.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.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public SearchGoogleAdsResponse.Builder clone()
      Specified by:
      clone in interface com.google.protobuf.Message.Builder
      Specified by:
      clone in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder>

    • setField

      public SearchGoogleAdsResponse.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder>

    • clearField

      public SearchGoogleAdsResponse.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder>

    • clearOneof

      public SearchGoogleAdsResponse.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder>

    • setRepeatedField

      public SearchGoogleAdsResponse.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder>

    • addRepeatedField

      public SearchGoogleAdsResponse.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder>

    • mergeFrom

      public SearchGoogleAdsResponse.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<SearchGoogleAdsResponse.Builder>

    • mergeFrom

      public SearchGoogleAdsResponse.Builder mergeFrom(SearchGoogleAdsResponse other)

    • isInitialized

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

    • mergeFrom

      public SearchGoogleAdsResponse.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<SearchGoogleAdsResponse.Builder>
      Throws:
      IOException

    • getResultsList

      public List<GoogleAdsRow> getResultsList()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;
      Specified by:
      getResultsList in interface SearchGoogleAdsResponseOrBuilder

    • getResultsCount

      public int getResultsCount()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;
      Specified by:
      getResultsCount in interface SearchGoogleAdsResponseOrBuilder

    • getResults

      public GoogleAdsRow getResults(int index)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;
      Specified by:
      getResults in interface SearchGoogleAdsResponseOrBuilder

    • setResults

      public SearchGoogleAdsResponse.Builder setResults(int index, GoogleAdsRow value)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • setResults

      public SearchGoogleAdsResponse.Builder setResults(int index, GoogleAdsRow.Builder builderForValue)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • addResults

      public SearchGoogleAdsResponse.Builder addResults(GoogleAdsRow value)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • addResults

      public SearchGoogleAdsResponse.Builder addResults(int index, GoogleAdsRow value)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • addResults

      public SearchGoogleAdsResponse.Builder addResults(GoogleAdsRow.Builder builderForValue)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • addResults

      public SearchGoogleAdsResponse.Builder addResults(int index, GoogleAdsRow.Builder builderForValue)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • addAllResults

      public SearchGoogleAdsResponse.Builder addAllResults(Iterable<? extends GoogleAdsRow> values)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • clearResults

      public SearchGoogleAdsResponse.Builder clearResults()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • removeResults

      public SearchGoogleAdsResponse.Builder removeResults(int index)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • getResultsBuilder

      public GoogleAdsRow.Builder getResultsBuilder(int index)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • getResultsOrBuilder

      public GoogleAdsRowOrBuilder getResultsOrBuilder(int index)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;
      Specified by:
      getResultsOrBuilder in interface SearchGoogleAdsResponseOrBuilder

    • getResultsOrBuilderList

      public List<? extends GoogleAdsRowOrBuilder> getResultsOrBuilderList()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;
      Specified by:
      getResultsOrBuilderList in interface SearchGoogleAdsResponseOrBuilder

    • addResultsBuilder

      public GoogleAdsRow.Builder addResultsBuilder()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • addResultsBuilder

      public GoogleAdsRow.Builder addResultsBuilder(int index)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • getResultsBuilderList

      public List<GoogleAdsRow.Builder> getResultsBuilderList()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • getNextPageToken

      public String getNextPageToken()
       Pagination token used to retrieve the next page of results.
 Pass the content of this string as the `page_token` attribute of
 the next request. `next_page_token` is not returned for the last
 page.
      string next_page_token = 2;
      Specified by:
      getNextPageToken in interface SearchGoogleAdsResponseOrBuilder
      Returns:
      The nextPageToken.

    • getNextPageTokenBytes

      public com.google.protobuf.ByteString getNextPageTokenBytes()
       Pagination token used to retrieve the next page of results.
 Pass the content of this string as the `page_token` attribute of
 the next request. `next_page_token` is not returned for the last
 page.
      string next_page_token = 2;
      Specified by:
      getNextPageTokenBytes in interface SearchGoogleAdsResponseOrBuilder
      Returns:
      The bytes for nextPageToken.

    • setNextPageToken

      public SearchGoogleAdsResponse.Builder setNextPageToken(String value)
       Pagination token used to retrieve the next page of results.
 Pass the content of this string as the `page_token` attribute of
 the next request. `next_page_token` is not returned for the last
 page.
      string next_page_token = 2;
      Parameters:
      value - The nextPageToken to set.
      Returns:
      This builder for chaining.

    • clearNextPageToken

      public SearchGoogleAdsResponse.Builder clearNextPageToken()
       Pagination token used to retrieve the next page of results.
 Pass the content of this string as the `page_token` attribute of
 the next request. `next_page_token` is not returned for the last
 page.
      string next_page_token = 2;
      Returns:
      This builder for chaining.

    • setNextPageTokenBytes

      public SearchGoogleAdsResponse.Builder setNextPageTokenBytes(com.google.protobuf.ByteString value)
       Pagination token used to retrieve the next page of results.
 Pass the content of this string as the `page_token` attribute of
 the next request. `next_page_token` is not returned for the last
 page.
      string next_page_token = 2;
      Parameters:
      value - The bytes for nextPageToken to set.
      Returns:
      This builder for chaining.

    • getTotalResultsCount

      public long getTotalResultsCount()
       Total number of results that match the query ignoring the LIMIT
 clause.
      int64 total_results_count = 3;
      Specified by:
      getTotalResultsCount in interface SearchGoogleAdsResponseOrBuilder
      Returns:
      The totalResultsCount.

    • setTotalResultsCount

      public SearchGoogleAdsResponse.Builder setTotalResultsCount(long value)
       Total number of results that match the query ignoring the LIMIT
 clause.
      int64 total_results_count = 3;
      Parameters:
      value - The totalResultsCount to set.
      Returns:
      This builder for chaining.

    • clearTotalResultsCount

      public SearchGoogleAdsResponse.Builder clearTotalResultsCount()
       Total number of results that match the query ignoring the LIMIT
 clause.
      int64 total_results_count = 3;
      Returns:
      This builder for chaining.

    • hasFieldMask

      public boolean hasFieldMask()
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 5;
      Specified by:
      hasFieldMask in interface SearchGoogleAdsResponseOrBuilder
      Returns:
      Whether the fieldMask field is set.

    • getFieldMask

      public com.google.protobuf.FieldMask getFieldMask()
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 5;
      Specified by:
      getFieldMask in interface SearchGoogleAdsResponseOrBuilder
      Returns:
      The fieldMask.

    • setFieldMask

      public SearchGoogleAdsResponse.Builder setFieldMask(com.google.protobuf.FieldMask value)
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 5;

    • setFieldMask

      public SearchGoogleAdsResponse.Builder setFieldMask(com.google.protobuf.FieldMask.Builder builderForValue)
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 5;

    • mergeFieldMask

      public SearchGoogleAdsResponse.Builder mergeFieldMask(com.google.protobuf.FieldMask value)
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 5;

    • clearFieldMask

      public SearchGoogleAdsResponse.Builder clearFieldMask()
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 5;

    • getFieldMaskBuilder

      public com.google.protobuf.FieldMask.Builder getFieldMaskBuilder()
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 5;

    • getFieldMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 5;
      Specified by:
      getFieldMaskOrBuilder in interface SearchGoogleAdsResponseOrBuilder

    • hasSummaryRow

      public boolean hasSummaryRow()
       Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
      .google.ads.googleads.v18.services.GoogleAdsRow summary_row = 6;
      Specified by:
      hasSummaryRow in interface SearchGoogleAdsResponseOrBuilder
      Returns:
      Whether the summaryRow field is set.

    • getSummaryRow

      public GoogleAdsRow getSummaryRow()
       Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
      .google.ads.googleads.v18.services.GoogleAdsRow summary_row = 6;
      Specified by:
      getSummaryRow in interface SearchGoogleAdsResponseOrBuilder
      Returns:
      The summaryRow.

    • setSummaryRow

      public SearchGoogleAdsResponse.Builder setSummaryRow(GoogleAdsRow value)
       Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
      .google.ads.googleads.v18.services.GoogleAdsRow summary_row = 6;

    • setSummaryRow

      public SearchGoogleAdsResponse.Builder setSummaryRow(GoogleAdsRow.Builder builderForValue)
       Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
      .google.ads.googleads.v18.services.GoogleAdsRow summary_row = 6;

    • mergeSummaryRow

      public SearchGoogleAdsResponse.Builder mergeSummaryRow(GoogleAdsRow value)
       Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
      .google.ads.googleads.v18.services.GoogleAdsRow summary_row = 6;

    • clearSummaryRow

      public SearchGoogleAdsResponse.Builder clearSummaryRow()
       Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
      .google.ads.googleads.v18.services.GoogleAdsRow summary_row = 6;

    • getSummaryRowBuilder

      public GoogleAdsRow.Builder getSummaryRowBuilder()
       Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
      .google.ads.googleads.v18.services.GoogleAdsRow summary_row = 6;

    • getSummaryRowOrBuilder

      public GoogleAdsRowOrBuilder getSummaryRowOrBuilder()
       Summary row that contains summary of metrics in results.
 Summary of metrics means aggregation of metrics across all results,
 here aggregation could be sum, average, rate, etc.
      .google.ads.googleads.v18.services.GoogleAdsRow summary_row = 6;
      Specified by:
      getSummaryRowOrBuilder in interface SearchGoogleAdsResponseOrBuilder

    • getQueryResourceConsumption

      public long getQueryResourceConsumption()
       The amount of resources consumed to serve the query.
      int64 query_resource_consumption = 8;
      Specified by:
      getQueryResourceConsumption in interface SearchGoogleAdsResponseOrBuilder
      Returns:
      The queryResourceConsumption.

    • setQueryResourceConsumption

      public SearchGoogleAdsResponse.Builder setQueryResourceConsumption(long value)
       The amount of resources consumed to serve the query.
      int64 query_resource_consumption = 8;
      Parameters:
      value - The queryResourceConsumption to set.
      Returns:
      This builder for chaining.

    • clearQueryResourceConsumption

      public SearchGoogleAdsResponse.Builder clearQueryResourceConsumption()
       The amount of resources consumed to serve the query.
      int64 query_resource_consumption = 8;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final SearchGoogleAdsResponse.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder>

    • mergeUnknownFields

      public final SearchGoogleAdsResponse.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsResponse.Builder>