Class SearchGoogleAdsStreamRequest

  • All Implemented Interfaces:
    SearchGoogleAdsStreamRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, java.io.Serializable

    public final class SearchGoogleAdsStreamRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements SearchGoogleAdsStreamRequestOrBuilder
     Request message for
     [GoogleAdsService.SearchStream][google.ads.googleads.v13.services.GoogleAdsService.SearchStream].
     
    Protobuf type google.ads.googleads.v13.services.SearchGoogleAdsStreamRequest
    See Also:
    Serialized Form
    • Field Detail

      • CUSTOMER_ID_FIELD_NUMBER

        public static final int CUSTOMER_ID_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SUMMARY_ROW_SETTING_FIELD_NUMBER

        public static final int SUMMARY_ROW_SETTING_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • 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
      • 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.
      • 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.
      • 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.v13.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3;
        Specified by:
        getSummaryRowSettingValue in interface SearchGoogleAdsStreamRequestOrBuilder
        Returns:
        The enum numeric value on the wire for summaryRowSetting.
      • 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.v13.enums.SummaryRowSettingEnum.SummaryRowSetting summary_row_setting = 3;
        Specified by:
        getSummaryRowSetting in interface SearchGoogleAdsStreamRequestOrBuilder
        Returns:
        The summaryRowSetting.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws java.io.IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        java.io.IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(java.lang.Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static SearchGoogleAdsStreamRequest parseFrom​(java.nio.ByteBuffer data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchGoogleAdsStreamRequest parseFrom​(java.nio.ByteBuffer data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchGoogleAdsStreamRequest parseFrom​(com.google.protobuf.ByteString data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchGoogleAdsStreamRequest parseFrom​(com.google.protobuf.ByteString data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchGoogleAdsStreamRequest parseFrom​(byte[] data)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchGoogleAdsStreamRequest parseFrom​(byte[] data,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static SearchGoogleAdsStreamRequest parseFrom​(java.io.InputStream input)
                                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static SearchGoogleAdsStreamRequest parseFrom​(java.io.InputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static SearchGoogleAdsStreamRequest parseDelimitedFrom​(java.io.InputStream input)
                                                               throws java.io.IOException
        Throws:
        java.io.IOException
      • parseDelimitedFrom

        public static SearchGoogleAdsStreamRequest parseDelimitedFrom​(java.io.InputStream input,
                                                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                               throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static SearchGoogleAdsStreamRequest parseFrom​(com.google.protobuf.CodedInputStream input)
                                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • parseFrom

        public static SearchGoogleAdsStreamRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • newBuilderForType

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

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

        protected SearchGoogleAdsStreamRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<SearchGoogleAdsStreamRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

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