Class Evaluation.EvaluationSpec.Builder (0.45.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.v1alpha.Evaluation.EvaluationSpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Evaluation.EvaluationSpec.Builder

Implements

Evaluation.EvaluationSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Evaluation.EvaluationSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Evaluation.EvaluationSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Evaluation.EvaluationSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Evaluation.EvaluationSpec.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearQuerySetSpec()

public Evaluation.EvaluationSpec.Builder clearQuerySetSpec()

Required. The specification of the query set.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Evaluation.EvaluationSpec getDefaultInstanceForType()

Returns
Type	Description
`Evaluation.EvaluationSpec`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getQuerySetSpec()

public Evaluation.EvaluationSpec.QuerySetSpec getQuerySetSpec()

Required. The specification of the query set.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeQuerySetSpec(Evaluation.EvaluationSpec.QuerySetSpec value)

public Evaluation.EvaluationSpec.Builder mergeQuerySetSpec(Evaluation.EvaluationSpec.QuerySetSpec value)

Required. The specification of the query set.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setQuerySetSpec(Evaluation.EvaluationSpec.QuerySetSpec value)

public Evaluation.EvaluationSpec.Builder setQuerySetSpec(Evaluation.EvaluationSpec.QuerySetSpec value)

Required. The specification of the query set.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)