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

Class SearchGoogleAdsStreamResponse.Builder

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

  • 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<SearchGoogleAdsStreamResponse.Builder>

    • clear

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

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

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

    • clearField

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

    • clearOneof

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

    • setRepeatedField

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

    • addRepeatedField

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

    • mergeFrom

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

    • mergeFrom

      public SearchGoogleAdsStreamResponse.Builder mergeFrom(SearchGoogleAdsStreamResponse other)

    • isInitialized

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

    • mergeFrom

      public SearchGoogleAdsStreamResponse.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<SearchGoogleAdsStreamResponse.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 SearchGoogleAdsStreamResponseOrBuilder

    • 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 SearchGoogleAdsStreamResponseOrBuilder

    • 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 SearchGoogleAdsStreamResponseOrBuilder

    • setResults

      public SearchGoogleAdsStreamResponse.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 SearchGoogleAdsStreamResponse.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 SearchGoogleAdsStreamResponse.Builder addResults(GoogleAdsRow value)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • addResults

      public SearchGoogleAdsStreamResponse.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 SearchGoogleAdsStreamResponse.Builder addResults(GoogleAdsRow.Builder builderForValue)
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • addResults

      public SearchGoogleAdsStreamResponse.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 SearchGoogleAdsStreamResponse.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 SearchGoogleAdsStreamResponse.Builder clearResults()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v18.services.GoogleAdsRow results = 1;

    • removeResults

      public SearchGoogleAdsStreamResponse.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 SearchGoogleAdsStreamResponseOrBuilder

    • 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 SearchGoogleAdsStreamResponseOrBuilder

    • 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;

    • hasFieldMask

      public boolean hasFieldMask()
       FieldMask that represents what fields were requested by the user.
      .google.protobuf.FieldMask field_mask = 2;
      Specified by:
      hasFieldMask in interface SearchGoogleAdsStreamResponseOrBuilder
      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 = 2;
      Specified by:
      getFieldMask in interface SearchGoogleAdsStreamResponseOrBuilder
      Returns:
      The fieldMask.

    • setFieldMask

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

    • setFieldMask

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

    • mergeFieldMask

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

    • clearFieldMask

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

    • getFieldMaskBuilder

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

    • getFieldMaskOrBuilder

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

    • 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 = 3;
      Specified by:
      hasSummaryRow in interface SearchGoogleAdsStreamResponseOrBuilder
      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 = 3;
      Specified by:
      getSummaryRow in interface SearchGoogleAdsStreamResponseOrBuilder
      Returns:
      The summaryRow.

    • setSummaryRow

      public SearchGoogleAdsStreamResponse.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 = 3;

    • setSummaryRow

      public SearchGoogleAdsStreamResponse.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 = 3;

    • mergeSummaryRow

      public SearchGoogleAdsStreamResponse.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 = 3;

    • clearSummaryRow

      public SearchGoogleAdsStreamResponse.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 = 3;

    • 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 = 3;

    • 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 = 3;
      Specified by:
      getSummaryRowOrBuilder in interface SearchGoogleAdsStreamResponseOrBuilder

    • getRequestId

      public String getRequestId()
       The unique id of the request that is used for debugging purposes.
      string request_id = 4;
      Specified by:
      getRequestId in interface SearchGoogleAdsStreamResponseOrBuilder
      Returns:
      The requestId.

    • getRequestIdBytes

      public com.google.protobuf.ByteString getRequestIdBytes()
       The unique id of the request that is used for debugging purposes.
      string request_id = 4;
      Specified by:
      getRequestIdBytes in interface SearchGoogleAdsStreamResponseOrBuilder
      Returns:
      The bytes for requestId.

    • setRequestId

      public SearchGoogleAdsStreamResponse.Builder setRequestId(String value)
       The unique id of the request that is used for debugging purposes.
      string request_id = 4;
      Parameters:
      value - The requestId to set.
      Returns:
      This builder for chaining.

    • clearRequestId

      public SearchGoogleAdsStreamResponse.Builder clearRequestId()
       The unique id of the request that is used for debugging purposes.
      string request_id = 4;
      Returns:
      This builder for chaining.

    • setRequestIdBytes

      public SearchGoogleAdsStreamResponse.Builder setRequestIdBytes(com.google.protobuf.ByteString value)
       The unique id of the request that is used for debugging purposes.
      string request_id = 4;
      Parameters:
      value - The bytes for requestId to set.
      Returns:
      This builder for chaining.

    • getQueryResourceConsumption

      public long getQueryResourceConsumption()
       The amount of resources consumed to serve the query.
 query_resource_consumption for the Summary row and non-Summary responses
 are returned separately in their respective rows.
 query_resource_consumption for non-Summary responses is returned in the
 final batch of results.
      int64 query_resource_consumption = 6;
      Specified by:
      getQueryResourceConsumption in interface SearchGoogleAdsStreamResponseOrBuilder
      Returns:
      The queryResourceConsumption.

    • setQueryResourceConsumption

      public SearchGoogleAdsStreamResponse.Builder setQueryResourceConsumption(long value)
       The amount of resources consumed to serve the query.
 query_resource_consumption for the Summary row and non-Summary responses
 are returned separately in their respective rows.
 query_resource_consumption for non-Summary responses is returned in the
 final batch of results.
      int64 query_resource_consumption = 6;
      Parameters:
      value - The queryResourceConsumption to set.
      Returns:
      This builder for chaining.

    • clearQueryResourceConsumption

      public SearchGoogleAdsStreamResponse.Builder clearQueryResourceConsumption()
       The amount of resources consumed to serve the query.
 query_resource_consumption for the Summary row and non-Summary responses
 are returned separately in their respective rows.
 query_resource_consumption for non-Summary responses is returned in the
 final batch of results.
      int64 query_resource_consumption = 6;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final SearchGoogleAdsStreamResponse.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<SearchGoogleAdsStreamResponse.Builder>

    • mergeUnknownFields

      public final SearchGoogleAdsStreamResponse.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<SearchGoogleAdsStreamResponse.Builder>