Package com.google.ads.googleads.v21.services

Class SearchGoogleAdsStreamResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableMessage<com.google.protobuf.GeneratedMessageV3>
com.google.protobuf.GeneratedMessageV3
com.google.ads.googleads.v21.services.SearchGoogleAdsStreamResponse
All Implemented Interfaces:
SearchGoogleAdsStreamResponseOrBuilder, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class SearchGoogleAdsStreamResponse extends com.google.protobuf.GeneratedMessageV3 implements SearchGoogleAdsStreamResponseOrBuilder
 Response message for
 [GoogleAdsService.SearchStream][google.ads.googleads.v21.services.GoogleAdsService.SearchStream].
Protobuf type google.ads.googleads.v21.services.SearchGoogleAdsStreamResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SearchGoogleAdsStreamResponse.Builder
    Response message for [GoogleAdsService.SearchStream][google.ads.googleads.v21.services.GoogleAdsService.SearchStream].

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionSerializer, com.google.protobuf.GeneratedMessage.ExtendableMessage.ExtensionWriter, com.google.protobuf.GeneratedMessage.ExtendableMessage.FieldEntry

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    FIELD_MASK_FIELD_NUMBER
     
    static final int
    QUERY_RESOURCE_CONSUMPTION_FIELD_NUMBER
     
    static final int
    REQUEST_ID_FIELD_NUMBER
     
    static final int
    RESULTS_FIELD_NUMBER
     
    static final int
    SUMMARY_ROW_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static SearchGoogleAdsStreamResponse
    getDefaultInstance()
     
    SearchGoogleAdsStreamResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.FieldMask
    getFieldMask()
    FieldMask that represents what fields were requested by the user.
    com.google.protobuf.FieldMaskOrBuilder
    getFieldMaskOrBuilder()
    FieldMask that represents what fields were requested by the user.
    com.google.protobuf.Parser<SearchGoogleAdsStreamResponse>
    getParserForType()
     
    long
    getQueryResourceConsumption()
    The amount of resources consumed to serve the query.
    String
    getRequestId()
    The unique id of the request that is used for debugging purposes.
    com.google.protobuf.ByteString
    getRequestIdBytes()
    The unique id of the request that is used for debugging purposes.
    GoogleAdsRow
    getResults(int index)
    The list of rows that matched the query.
    int
    getResultsCount()
    The list of rows that matched the query.
    List<GoogleAdsRow>
    getResultsList()
    The list of rows that matched the query.
    GoogleAdsRowOrBuilder
    getResultsOrBuilder(int index)
    The list of rows that matched the query.
    List<? extends GoogleAdsRowOrBuilder>
    getResultsOrBuilderList()
    The list of rows that matched the query.
    int
    getSerializedSize()
     
    GoogleAdsRow
    getSummaryRow()
    Summary row that contains summary of metrics in results.
    GoogleAdsRowOrBuilder
    getSummaryRowOrBuilder()
    Summary row that contains summary of metrics in results.
    boolean
    hasFieldMask()
    FieldMask that represents what fields were requested by the user.
    int
    hashCode()
     
    boolean
    hasSummaryRow()
    Summary row that contains summary of metrics in results.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SearchGoogleAdsStreamResponse.Builder
    newBuilder()
     
    static SearchGoogleAdsStreamResponse.Builder
    newBuilder(SearchGoogleAdsStreamResponse prototype)
     
    SearchGoogleAdsStreamResponse.Builder
    newBuilderForType()
     
    protected SearchGoogleAdsStreamResponse.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static SearchGoogleAdsStreamResponse
    parseDelimitedFrom(InputStream input)
     
    static SearchGoogleAdsStreamResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchGoogleAdsStreamResponse
    parseFrom(byte[] data)
     
    static SearchGoogleAdsStreamResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchGoogleAdsStreamResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static SearchGoogleAdsStreamResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchGoogleAdsStreamResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SearchGoogleAdsStreamResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchGoogleAdsStreamResponse
    parseFrom(InputStream input)
     
    static SearchGoogleAdsStreamResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchGoogleAdsStreamResponse
    parseFrom(ByteBuffer data)
     
    static SearchGoogleAdsStreamResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SearchGoogleAdsStreamResponse>
    parser()
     
    SearchGoogleAdsStreamResponse.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList

    Methods inherited from class com.google.protobuf.GeneratedMessage.ExtendableMessage

    extensionsAreInitialized, extensionsIterator, extensionsSerializedSize, extensionsSerializedSizeAsMessageSet, getAllFields, getAllFieldsRaw, getExtension, getExtension, getExtensionCount, getExtensionFields, getField, getRepeatedField, getRepeatedFieldCount, hasExtension, hasField, makeExtensionsImmutable, newExtensionSerializer, newExtensionWriter, newMessageSetExtensionSerializer, newMessageSetExtensionWriter

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getDescriptorForType, getOneofFieldDescriptor, getUnknownFields, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder

    getExtension, getExtension, getExtension, getExtension, getExtensionCount, getExtensionCount, hasExtension, hasExtension

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • RESULTS_FIELD_NUMBER

      public static final int RESULTS_FIELD_NUMBER
      See Also:

    • FIELD_MASK_FIELD_NUMBER

      public static final int FIELD_MASK_FIELD_NUMBER
      See Also:

    • SUMMARY_ROW_FIELD_NUMBER

      public static final int SUMMARY_ROW_FIELD_NUMBER
      See Also:

    • REQUEST_ID_FIELD_NUMBER

      public static final int REQUEST_ID_FIELD_NUMBER
      See Also:

    • QUERY_RESOURCE_CONSUMPTION_FIELD_NUMBER

      public static final int QUERY_RESOURCE_CONSUMPTION_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()
      Overrides:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getResultsList

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

    • getResultsOrBuilderList

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

    • getResultsCount

      public int getResultsCount()
       The list of rows that matched the query.
      repeated .google.ads.googleads.v21.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.v21.services.GoogleAdsRow results = 1;
      Specified by:
      getResults in interface SearchGoogleAdsStreamResponseOrBuilder

    • getResultsOrBuilder

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

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

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

    • 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.v21.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.

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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.ExtendableMessage<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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 SearchGoogleAdsStreamResponse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchGoogleAdsStreamResponse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchGoogleAdsStreamResponse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static SearchGoogleAdsStreamResponse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static SearchGoogleAdsStreamResponse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchGoogleAdsStreamResponse.Builder newBuilder()

    • newBuilder

      public static SearchGoogleAdsStreamResponse.Builder newBuilder(SearchGoogleAdsStreamResponse prototype)

    • toBuilder

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

    • newBuilderForType

      protected SearchGoogleAdsStreamResponse.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static SearchGoogleAdsStreamResponse getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchGoogleAdsStreamResponse> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchGoogleAdsStreamResponse> 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.GeneratedMessage

    • getDefaultInstanceForType

      public SearchGoogleAdsStreamResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<com.google.protobuf.GeneratedMessageV3>
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder