Package com.google.ads.googleads.v24.services

Class KnowledgeGraphEntitySearchOptions.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<KnowledgeGraphEntitySearchOptions.Builder>
com.google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.Builder
All Implemented Interfaces:
KnowledgeGraphEntitySearchOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
KnowledgeGraphEntitySearchOptions
public static final class KnowledgeGraphEntitySearchOptions.Builder extends com.google.protobuf.GeneratedMessage.Builder<KnowledgeGraphEntitySearchOptions.Builder> implements KnowledgeGraphEntitySearchOptionsOrBuilder
 Search options for Knowledge Graph Entities.
Protobuf type google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<KnowledgeGraphEntitySearchOptions.Builder>

    • clear

      public KnowledgeGraphEntitySearchOptions.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.GeneratedMessage.Builder<KnowledgeGraphEntitySearchOptions.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.GeneratedMessage.Builder<KnowledgeGraphEntitySearchOptions.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

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

    • mergeFrom

      public KnowledgeGraphEntitySearchOptions.Builder mergeFrom(KnowledgeGraphEntitySearchOptions other)

    • isInitialized

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

    • mergeFrom

      public KnowledgeGraphEntitySearchOptions.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<KnowledgeGraphEntitySearchOptions.Builder>
      Throws:
      IOException

    • getGetAllCreatorAttributes

      public boolean getGetAllCreatorAttributes()
       Optional. When true, retrieves all available Knowledge Graph Entities
 tagged with
 [CREATOR_ATTRIBUTE][google.ads.googleads.v24.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_ATTRIBUTE].
 KNOWLEDGE_GRAPH must be included in
 `ListAudienceInsightsAttributesRequest.dimensions` and the `query_text`
 must be empty.

 This option cannot be used with
 [search_filter][google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.search_filter].
 `search_filter` respects the `query_text` when retrieving relevant entities
 while this option returns all creator attributes available to use as an
 input.
      bool get_all_creator_attributes = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGetAllCreatorAttributes in interface KnowledgeGraphEntitySearchOptionsOrBuilder
      Returns:
      The getAllCreatorAttributes.

    • setGetAllCreatorAttributes

      public KnowledgeGraphEntitySearchOptions.Builder setGetAllCreatorAttributes(boolean value)
       Optional. When true, retrieves all available Knowledge Graph Entities
 tagged with
 [CREATOR_ATTRIBUTE][google.ads.googleads.v24.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_ATTRIBUTE].
 KNOWLEDGE_GRAPH must be included in
 `ListAudienceInsightsAttributesRequest.dimensions` and the `query_text`
 must be empty.

 This option cannot be used with
 [search_filter][google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.search_filter].
 `search_filter` respects the `query_text` when retrieving relevant entities
 while this option returns all creator attributes available to use as an
 input.
      bool get_all_creator_attributes = 1 [(.google.api.field_behavior) = OPTIONAL];
      Parameters:
      value - The getAllCreatorAttributes to set.
      Returns:
      This builder for chaining.

    • clearGetAllCreatorAttributes

      public KnowledgeGraphEntitySearchOptions.Builder clearGetAllCreatorAttributes()
       Optional. When true, retrieves all available Knowledge Graph Entities
 tagged with
 [CREATOR_ATTRIBUTE][google.ads.googleads.v24.enums.InsightsKnowledgeGraphEntityCapabilitiesEnum.InsightsKnowledgeGraphEntityCapabilities.CREATOR_ATTRIBUTE].
 KNOWLEDGE_GRAPH must be included in
 `ListAudienceInsightsAttributesRequest.dimensions` and the `query_text`
 must be empty.

 This option cannot be used with
 [search_filter][google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.search_filter].
 `search_filter` respects the `query_text` when retrieving relevant entities
 while this option returns all creator attributes available to use as an
 input.
      bool get_all_creator_attributes = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      This builder for chaining.

    • hasSearchFilter

      public boolean hasSearchFilter()
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSearchFilter in interface KnowledgeGraphEntitySearchOptionsOrBuilder
      Returns:
      Whether the searchFilter field is set.

    • getSearchFilter

      public KnowledgeGraphEntitySearchOptions.SearchFilter getSearchFilter()
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchFilter in interface KnowledgeGraphEntitySearchOptionsOrBuilder
      Returns:
      The searchFilter.

    • setSearchFilter

      public KnowledgeGraphEntitySearchOptions.Builder setSearchFilter(KnowledgeGraphEntitySearchOptions.SearchFilter value)
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

    • setSearchFilter

      public KnowledgeGraphEntitySearchOptions.Builder setSearchFilter(KnowledgeGraphEntitySearchOptions.SearchFilter.Builder builderForValue)
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

    • mergeSearchFilter

      public KnowledgeGraphEntitySearchOptions.Builder mergeSearchFilter(KnowledgeGraphEntitySearchOptions.SearchFilter value)
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

    • clearSearchFilter

      public KnowledgeGraphEntitySearchOptions.Builder clearSearchFilter()
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getSearchFilterBuilder

      public KnowledgeGraphEntitySearchOptions.SearchFilter.Builder getSearchFilterBuilder()
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];

    • getSearchFilterOrBuilder

      public KnowledgeGraphEntitySearchOptions.SearchFilterOrBuilder getSearchFilterOrBuilder()
       Optional. Filter options for narrowing down the scope of Knowledge Graph
 Entities to retrieve.
      .google.ads.googleads.v24.services.KnowledgeGraphEntitySearchOptions.SearchFilter search_filter = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchFilterOrBuilder in interface KnowledgeGraphEntitySearchOptionsOrBuilder