com.google.cloud.discoveryengine.v1alpha

Class Evaluation.EvaluationSpec

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.Evaluation.EvaluationSpec

All Implemented Interfaces:

Evaluation.EvaluationSpecOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Evaluation

public static final class Evaluation.EvaluationSpec
extends com.google.protobuf.GeneratedMessageV3
implements Evaluation.EvaluationSpecOrBuilder

 Describes the specification of the evaluation.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Evaluation.EvaluationSpec.Builder Describes the specification of the evaluation.
static class	Evaluation.EvaluationSpec.QuerySetSpec Describes the specification of the query set.
static interface	Evaluation.EvaluationSpec.QuerySetSpecOrBuilder
static class	Evaluation.EvaluationSpec.SearchSpecCase

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

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	QUERY_SET_SPEC_FIELD_NUMBER
static int	SEARCH_REQUEST_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, 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 and Description
boolean	equals(Object obj)
static Evaluation.EvaluationSpec	getDefaultInstance()
Evaluation.EvaluationSpec	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Parser<Evaluation.EvaluationSpec>	getParserForType()
Evaluation.EvaluationSpec.QuerySetSpec	getQuerySetSpec() Required.
Evaluation.EvaluationSpec.QuerySetSpecOrBuilder	getQuerySetSpecOrBuilder() Required.
SearchRequest	getSearchRequest() Required.
SearchRequestOrBuilder	getSearchRequestOrBuilder() Required.
Evaluation.EvaluationSpec.SearchSpecCase	getSearchSpecCase()
int	getSerializedSize()
int	hashCode()
boolean	hasQuerySetSpec() Required.
boolean	hasSearchRequest() Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Evaluation.EvaluationSpec.Builder	newBuilder()
static Evaluation.EvaluationSpec.Builder	newBuilder(Evaluation.EvaluationSpec prototype)
Evaluation.EvaluationSpec.Builder	newBuilderForType()
protected Evaluation.EvaluationSpec.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Evaluation.EvaluationSpec	parseDelimitedFrom(InputStream input)
static Evaluation.EvaluationSpec	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation.EvaluationSpec	parseFrom(byte[] data)
static Evaluation.EvaluationSpec	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation.EvaluationSpec	parseFrom(ByteBuffer data)
static Evaluation.EvaluationSpec	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation.EvaluationSpec	parseFrom(com.google.protobuf.ByteString data)
static Evaluation.EvaluationSpec	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation.EvaluationSpec	parseFrom(com.google.protobuf.CodedInputStream input)
static Evaluation.EvaluationSpec	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Evaluation.EvaluationSpec	parseFrom(InputStream input)
static Evaluation.EvaluationSpec	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Evaluation.EvaluationSpec>	parser()
Evaluation.EvaluationSpec.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SEARCH_REQUEST_FIELD_NUMBER

public static final int SEARCH_REQUEST_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_SET_SPEC_FIELD_NUMBER

public static final int QUERY_SET_SPEC_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

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()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSearchSpecCase

public Evaluation.EvaluationSpec.SearchSpecCase getSearchSpecCase()

Specified by:

getSearchSpecCase in interface Evaluation.EvaluationSpecOrBuilder

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.v1alpha.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]
 

.google.cloud.discoveryengine.v1alpha.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.v1alpha.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]
 

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

Specified by:

getSearchRequest in interface Evaluation.EvaluationSpecOrBuilder

Returns:

The searchRequest.

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.v1alpha.SearchRequest.serving_config]
 * [SearchRequest.branch][google.cloud.discoveryengine.v1alpha.SearchRequest.branch]
 * [SearchRequest.canonical_filter][google.cloud.discoveryengine.v1alpha.SearchRequest.canonical_filter]
 * [SearchRequest.query_expansion_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.query_expansion_spec]
 * [SearchRequest.spell_correction_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.spell_correction_spec]
 * [SearchRequest.content_search_spec][google.cloud.discoveryengine.v1alpha.SearchRequest.content_search_spec]
 * [SearchRequest.user_pseudo_id][google.cloud.discoveryengine.v1alpha.SearchRequest.user_pseudo_id]
 

.google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.Evaluation.EvaluationSpec.QuerySetSpec query_set_spec = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getQuerySetSpec in interface Evaluation.EvaluationSpecOrBuilder

Returns:

The querySetSpec.

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

Specified by:

getQuerySetSpecOrBuilder in interface Evaluation.EvaluationSpecOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class 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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 Evaluation.EvaluationSpec parseFrom(ByteBuffer data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.EvaluationSpec parseFrom(ByteBuffer data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.EvaluationSpec parseFrom(com.google.protobuf.ByteString data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.EvaluationSpec parseFrom(com.google.protobuf.ByteString data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.EvaluationSpec parseFrom(byte[] data)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.EvaluationSpec parseFrom(byte[] data,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Evaluation.EvaluationSpec parseFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static Evaluation.EvaluationSpec parseFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static Evaluation.EvaluationSpec parseDelimitedFrom(InputStream input)
                                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static Evaluation.EvaluationSpec parseDelimitedFrom(InputStream input,
                                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                    throws IOException

Throws:

IOException

parseFrom

public static Evaluation.EvaluationSpec parseFrom(com.google.protobuf.CodedInputStream input)
                                           throws IOException

Throws:

IOException

parseFrom

public static Evaluation.EvaluationSpec parseFrom(com.google.protobuf.CodedInputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

newBuilderForType

public Evaluation.EvaluationSpec.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Evaluation.EvaluationSpec.Builder newBuilder()

newBuilder

public static Evaluation.EvaluationSpec.Builder newBuilder(Evaluation.EvaluationSpec prototype)

toBuilder

public Evaluation.EvaluationSpec.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Evaluation.EvaluationSpec.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Evaluation.EvaluationSpec getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Evaluation.EvaluationSpec> 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.GeneratedMessageV3

getDefaultInstanceForType

public Evaluation.EvaluationSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder