Package com.google.cloud.discoveryengine.v1beta

Class Evaluation.EvaluationSpec.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Evaluation.EvaluationSpec.Builder>
com.google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.Builder
All Implemented Interfaces:
Evaluation.EvaluationSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Evaluation.EvaluationSpec
public static final class Evaluation.EvaluationSpec.Builder extends com.google.protobuf.GeneratedMessage.Builder<Evaluation.EvaluationSpec.Builder> implements Evaluation.EvaluationSpecOrBuilder
 Describes the specification of the evaluation.
Protobuf type google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec

  • 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<Evaluation.EvaluationSpec.Builder>

    • clear

      public Evaluation.EvaluationSpec.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<Evaluation.EvaluationSpec.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<Evaluation.EvaluationSpec.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Evaluation.EvaluationSpec.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<Evaluation.EvaluationSpec.Builder>

    • mergeFrom

      public Evaluation.EvaluationSpec.Builder mergeFrom(Evaluation.EvaluationSpec other)

    • isInitialized

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

    • mergeFrom

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

    • getSearchSpecCase

      public Evaluation.EvaluationSpec.SearchSpecCase getSearchSpecCase()
      Specified by:
      getSearchSpecCase in interface Evaluation.EvaluationSpecOrBuilder

    • clearSearchSpec

      public Evaluation.EvaluationSpec.Builder clearSearchSpec()

    • hasSearchRequest

      public boolean hasSearchRequest()
       Required. The search request that is used to perform the evaluation.

 Only the following fields within SearchRequest are supported; if any
 other fields are provided, an UNSUPPORTED error will be returned:

 * [SearchRequest.serving_config][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasSearchRequest in interface Evaluation.EvaluationSpecOrBuilder
      Returns:
      Whether the searchRequest field is set.

    • getSearchRequest

      public SearchRequest getSearchRequest()
       Required. The search request that is used to perform the evaluation.

 Only the following fields within SearchRequest are supported; if any
 other fields are provided, an UNSUPPORTED error will be returned:

 * [SearchRequest.serving_config][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getSearchRequest in interface Evaluation.EvaluationSpecOrBuilder
      Returns:
      The searchRequest.

    • setSearchRequest

      public Evaluation.EvaluationSpec.Builder setSearchRequest(SearchRequest value)
       Required. The search request that is used to perform the evaluation.

 Only the following fields within SearchRequest are supported; if any
 other fields are provided, an UNSUPPORTED error will be returned:

 * [SearchRequest.serving_config][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

    • setSearchRequest

      public Evaluation.EvaluationSpec.Builder setSearchRequest(SearchRequest.Builder builderForValue)
       Required. The search request that is used to perform the evaluation.

 Only the following fields within SearchRequest are supported; if any
 other fields are provided, an UNSUPPORTED error will be returned:

 * [SearchRequest.serving_config][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

    • mergeSearchRequest

      public Evaluation.EvaluationSpec.Builder mergeSearchRequest(SearchRequest value)
       Required. The search request that is used to perform the evaluation.

 Only the following fields within SearchRequest are supported; if any
 other fields are provided, an UNSUPPORTED error will be returned:

 * [SearchRequest.serving_config][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

    • clearSearchRequest

      public Evaluation.EvaluationSpec.Builder clearSearchRequest()
       Required. The search request that is used to perform the evaluation.

 Only the following fields within SearchRequest are supported; if any
 other fields are provided, an UNSUPPORTED error will be returned:

 * [SearchRequest.serving_config][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

    • getSearchRequestBuilder

      public SearchRequest.Builder getSearchRequestBuilder()
       Required. The search request that is used to perform the evaluation.

 Only the following fields within SearchRequest are supported; if any
 other fields are provided, an UNSUPPORTED error will be returned:

 * [SearchRequest.serving_config][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

    • getSearchRequestOrBuilder

      public SearchRequestOrBuilder getSearchRequestOrBuilder()
       Required. The search request that is used to perform the evaluation.

 Only the following fields within SearchRequest are supported; if any
 other fields are provided, an UNSUPPORTED error will be returned:

 * [SearchRequest.serving_config][google.cloud.discoveryengine.v1beta.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1beta.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1beta.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1beta.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1beta.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1beta.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1beta.SearchRequest.user_pseudo_id]
      .google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getSearchRequestOrBuilder in interface Evaluation.EvaluationSpecOrBuilder

    • hasQuerySetSpec

      public boolean hasQuerySetSpec()
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasQuerySetSpec in interface Evaluation.EvaluationSpecOrBuilder
      Returns:
      Whether the querySetSpec field is set.

    • getQuerySetSpec

      public Evaluation.EvaluationSpec.QuerySetSpec getQuerySetSpec()
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuerySetSpec in interface Evaluation.EvaluationSpecOrBuilder
      Returns:
      The querySetSpec.

    • setQuerySetSpec

      public Evaluation.EvaluationSpec.Builder setQuerySetSpec(Evaluation.EvaluationSpec.QuerySetSpec value)
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];

    • setQuerySetSpec

      public Evaluation.EvaluationSpec.Builder setQuerySetSpec(Evaluation.EvaluationSpec.QuerySetSpec.Builder builderForValue)
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];

    • mergeQuerySetSpec

      public Evaluation.EvaluationSpec.Builder mergeQuerySetSpec(Evaluation.EvaluationSpec.QuerySetSpec value)
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];

    • clearQuerySetSpec

      public Evaluation.EvaluationSpec.Builder clearQuerySetSpec()
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];

    • getQuerySetSpecBuilder

      public Evaluation.EvaluationSpec.QuerySetSpec.Builder getQuerySetSpecBuilder()
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];

    • getQuerySetSpecOrBuilder

      public Evaluation.EvaluationSpec.QuerySetSpecOrBuilder getQuerySetSpecOrBuilder()
       Required. The specification of the query set.
      .google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuerySetSpecOrBuilder in interface Evaluation.EvaluationSpecOrBuilder