Class Evaluation.EvaluationSpec.Builder (0.49.0)

public static final class Evaluation.EvaluationSpec.Builder extends GeneratedMessageV3.Builder<Evaluation.EvaluationSpec.Builder> implements Evaluation.EvaluationSpecOrBuilder

Describes the specification of the evaluation.

Protobuf type google.cloud.discoveryengine.v1beta.Evaluation.EvaluationSpec

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.EvaluationSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides

build()

public Evaluation.EvaluationSpec build()
Returns
Type Description
Evaluation.EvaluationSpec

buildPartial()

public Evaluation.EvaluationSpec buildPartial()
Returns
Type Description
Evaluation.EvaluationSpec

clear()

public Evaluation.EvaluationSpec.Builder clear()
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Evaluation.EvaluationSpec.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Evaluation.EvaluationSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides

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];

Returns
Type Description
Evaluation.EvaluationSpec.Builder

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
  • SearchRequest.branch
  • SearchRequest.canonical_filter
  • SearchRequest.query_expansion_spec
  • SearchRequest.spell_correction_spec
  • SearchRequest.content_search_spec
  • SearchRequest.user_pseudo_id

.google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Evaluation.EvaluationSpec.Builder

clearSearchSpec()

public Evaluation.EvaluationSpec.Builder clearSearchSpec()
Returns
Type Description
Evaluation.EvaluationSpec.Builder

clone()

public Evaluation.EvaluationSpec.Builder clone()
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides

getDefaultInstanceForType()

public Evaluation.EvaluationSpec getDefaultInstanceForType()
Returns
Type Description
Evaluation.EvaluationSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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];

Returns
Type Description
Evaluation.EvaluationSpec.QuerySetSpec

The querySetSpec.

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];

Returns
Type Description
Evaluation.EvaluationSpec.QuerySetSpec.Builder

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];

Returns
Type Description
Evaluation.EvaluationSpec.QuerySetSpecOrBuilder

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
  • SearchRequest.branch
  • SearchRequest.canonical_filter
  • SearchRequest.query_expansion_spec
  • SearchRequest.spell_correction_spec
  • SearchRequest.content_search_spec
  • SearchRequest.user_pseudo_id

.google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SearchRequest

The searchRequest.

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
  • SearchRequest.branch
  • SearchRequest.canonical_filter
  • SearchRequest.query_expansion_spec
  • SearchRequest.spell_correction_spec
  • SearchRequest.content_search_spec
  • SearchRequest.user_pseudo_id

.google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SearchRequest.Builder

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
  • SearchRequest.branch
  • SearchRequest.canonical_filter
  • SearchRequest.query_expansion_spec
  • SearchRequest.spell_correction_spec
  • SearchRequest.content_search_spec
  • SearchRequest.user_pseudo_id

.google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
SearchRequestOrBuilder

getSearchSpecCase()

public Evaluation.EvaluationSpec.SearchSpecCase getSearchSpecCase()
Returns
Type Description
Evaluation.EvaluationSpec.SearchSpecCase

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];

Returns
Type Description
boolean

Whether the querySetSpec field is set.

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
  • SearchRequest.branch
  • SearchRequest.canonical_filter
  • SearchRequest.query_expansion_spec
  • SearchRequest.spell_correction_spec
  • SearchRequest.content_search_spec
  • SearchRequest.user_pseudo_id

.google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the searchRequest field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Evaluation.EvaluationSpec other)

public Evaluation.EvaluationSpec.Builder mergeFrom(Evaluation.EvaluationSpec other)
Parameter
Name Description
other Evaluation.EvaluationSpec
Returns
Type Description
Evaluation.EvaluationSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Evaluation.EvaluationSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Evaluation.EvaluationSpec.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides

mergeQuerySetSpec(Evaluation.EvaluationSpec.QuerySetSpec value)

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];

Parameter
Name Description
value Evaluation.EvaluationSpec.QuerySetSpec
Returns
Type Description
Evaluation.EvaluationSpec.Builder

mergeSearchRequest(SearchRequest value)

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
  • SearchRequest.branch
  • SearchRequest.canonical_filter
  • SearchRequest.query_expansion_spec
  • SearchRequest.spell_correction_spec
  • SearchRequest.content_search_spec
  • SearchRequest.user_pseudo_id

.google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value SearchRequest
Returns
Type Description
Evaluation.EvaluationSpec.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.EvaluationSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Evaluation.EvaluationSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides

setQuerySetSpec(Evaluation.EvaluationSpec.QuerySetSpec value)

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];

Parameter
Name Description
value Evaluation.EvaluationSpec.QuerySetSpec
Returns
Type Description
Evaluation.EvaluationSpec.Builder

setQuerySetSpec(Evaluation.EvaluationSpec.QuerySetSpec.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Evaluation.EvaluationSpec.QuerySetSpec.Builder
Returns
Type Description
Evaluation.EvaluationSpec.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Evaluation.EvaluationSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides

setSearchRequest(SearchRequest value)

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
  • SearchRequest.branch
  • SearchRequest.canonical_filter
  • SearchRequest.query_expansion_spec
  • SearchRequest.spell_correction_spec
  • SearchRequest.content_search_spec
  • SearchRequest.user_pseudo_id

.google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value SearchRequest
Returns
Type Description
Evaluation.EvaluationSpec.Builder

setSearchRequest(SearchRequest.Builder builderForValue)

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
  • SearchRequest.branch
  • SearchRequest.canonical_filter
  • SearchRequest.query_expansion_spec
  • SearchRequest.spell_correction_spec
  • SearchRequest.content_search_spec
  • SearchRequest.user_pseudo_id

.google.cloud.discoveryengine.v1beta.SearchRequest search_request = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
builderForValue SearchRequest.Builder
Returns
Type Description
Evaluation.EvaluationSpec.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Evaluation.EvaluationSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides