Class SearchGoogleAdsStreamRequest.Builder

  • All Implemented Interfaces:
    SearchGoogleAdsStreamRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.lang.Cloneable
    Enclosing class:
    SearchGoogleAdsStreamRequest

    public static final class SearchGoogleAdsStreamRequest.Builder
    extends com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsStreamRequest.Builder>
    implements SearchGoogleAdsStreamRequestOrBuilder
     Request message for [GoogleAdsService.SearchStream][google.ads.googleads.v10.services.GoogleAdsService.SearchStream].
     
    Protobuf type google.ads.googleads.v10.services.SearchGoogleAdsStreamRequest
    • Method Detail

      • 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<SearchGoogleAdsStreamRequest.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<SearchGoogleAdsStreamRequest.Builder>
      • getDefaultInstanceForType

        public SearchGoogleAdsStreamRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
      • build

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

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

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

        public SearchGoogleAdsStreamRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                     java.lang.Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchGoogleAdsStreamRequest.Builder>
      • isInitialized

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

        public SearchGoogleAdsStreamRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                       throws java.io.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<SearchGoogleAdsStreamRequest.Builder>
        Throws:
        java.io.IOException
      • getCustomerId

        public java.lang.String getCustomerId()
         Required. The ID of the customer being queried.
         
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCustomerId in interface SearchGoogleAdsStreamRequestOrBuilder
        Returns:
        The customerId.
      • getCustomerIdBytes

        public com.google.protobuf.ByteString getCustomerIdBytes()
         Required. The ID of the customer being queried.
         
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getCustomerIdBytes in interface SearchGoogleAdsStreamRequestOrBuilder
        Returns:
        The bytes for customerId.
      • setCustomerId

        public SearchGoogleAdsStreamRequest.Builder setCustomerId​(java.lang.String value)
         Required. The ID of the customer being queried.
         
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The customerId to set.
        Returns:
        This builder for chaining.
      • clearCustomerId

        public SearchGoogleAdsStreamRequest.Builder clearCustomerId()
         Required. The ID of the customer being queried.
         
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.
      • setCustomerIdBytes

        public SearchGoogleAdsStreamRequest.Builder setCustomerIdBytes​(com.google.protobuf.ByteString value)
         Required. The ID of the customer being queried.
         
        string customer_id = 1 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for customerId to set.
        Returns:
        This builder for chaining.
      • getQuery

        public java.lang.String getQuery()
         Required. The query string.
         
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getQuery in interface SearchGoogleAdsStreamRequestOrBuilder
        Returns:
        The query.
      • getQueryBytes

        public com.google.protobuf.ByteString getQueryBytes()
         Required. The query string.
         
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getQueryBytes in interface SearchGoogleAdsStreamRequestOrBuilder
        Returns:
        The bytes for query.
      • setQuery

        public SearchGoogleAdsStreamRequest.Builder setQuery​(java.lang.String value)
         Required. The query string.
         
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The query to set.
        Returns:
        This builder for chaining.
      • clearQuery

        public SearchGoogleAdsStreamRequest.Builder clearQuery()
         Required. The query string.
         
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        This builder for chaining.
      • setQueryBytes

        public SearchGoogleAdsStreamRequest.Builder setQueryBytes​(com.google.protobuf.ByteString value)
         Required. The query string.
         
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Parameters:
        value - The bytes for query to set.
        Returns:
        This builder for chaining.
      • getSummaryRowSettingValue

        public int getSummaryRowSettingValue()
         Determines whether a summary row will be returned. By default, summary row
         is not returned. If requested, the summary row will be sent in a response
         by itself after all other query results are returned.
         
        .google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3;
        Specified by:
        getSummaryRowSettingValue in interface SearchGoogleAdsStreamRequestOrBuilder
        Returns:
        The enum numeric value on the wire for summaryRowSetting.
      • setSummaryRowSettingValue

        public SearchGoogleAdsStreamRequest.Builder setSummaryRowSettingValue​(int value)
         Determines whether a summary row will be returned. By default, summary row
         is not returned. If requested, the summary row will be sent in a response
         by itself after all other query results are returned.
         
        .google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3;
        Parameters:
        value - The enum numeric value on the wire for summaryRowSetting to set.
        Returns:
        This builder for chaining.
      • getSummaryRowSetting

        public SummaryRowSettingEnum.SummaryRowSetting getSummaryRowSetting()
         Determines whether a summary row will be returned. By default, summary row
         is not returned. If requested, the summary row will be sent in a response
         by itself after all other query results are returned.
         
        .google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3;
        Specified by:
        getSummaryRowSetting in interface SearchGoogleAdsStreamRequestOrBuilder
        Returns:
        The summaryRowSetting.
      • setSummaryRowSetting

        public SearchGoogleAdsStreamRequest.Builder setSummaryRowSetting​(SummaryRowSettingEnum.SummaryRowSetting value)
         Determines whether a summary row will be returned. By default, summary row
         is not returned. If requested, the summary row will be sent in a response
         by itself after all other query results are returned.
         
        .google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3;
        Parameters:
        value - The summaryRowSetting to set.
        Returns:
        This builder for chaining.
      • clearSummaryRowSetting

        public SearchGoogleAdsStreamRequest.Builder clearSummaryRowSetting()
         Determines whether a summary row will be returned. By default, summary row
         is not returned. If requested, the summary row will be sent in a response
         by itself after all other query results are returned.
         
        .google.ads.googleads.v10.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3;
        Returns:
        This builder for chaining.