Class SearchGoogleAdsStreamRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v18.services.SearchGoogleAdsStreamRequest
All Implemented Interfaces:
SearchGoogleAdsStreamRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

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

    • CUSTOMER_ID_FIELD_NUMBER

      public static final int CUSTOMER_ID_FIELD_NUMBER
      See Also:
    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:
    • SUMMARY_ROW_SETTING_FIELD_NUMBER

      public static final int SUMMARY_ROW_SETTING_FIELD_NUMBER
      See Also:
  • Method Details

    • newInstance

      protected 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 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 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.v18.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.v18.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 IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      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(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(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static SearchGoogleAdsStreamRequest parseFrom(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(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

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

      public static SearchGoogleAdsStreamRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

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

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

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

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

      public static SearchGoogleAdsStreamRequest.Builder newBuilder()
    • newBuilder

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

      public static SearchGoogleAdsStreamRequest getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<SearchGoogleAdsStreamRequest> parser()
    • 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