Class Evaluation.EvaluationSpec (0.45.0)

public static final class Evaluation.EvaluationSpec extends GeneratedMessageV3 implements Evaluation.EvaluationSpecOrBuilder

Describes the specification of the evaluation.

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

Static Fields

QUERY_SET_SPEC_FIELD_NUMBER

public static final int QUERY_SET_SPEC_FIELD_NUMBER
Field Value
Type Description
int

SEARCH_REQUEST_FIELD_NUMBER

public static final int SEARCH_REQUEST_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Evaluation.EvaluationSpec getDefaultInstance()
Returns
Type Description
Evaluation.EvaluationSpec

getDescriptor()

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

newBuilder()

public static Evaluation.EvaluationSpec.Builder newBuilder()
Returns
Type Description
Evaluation.EvaluationSpec.Builder

newBuilder(Evaluation.EvaluationSpec prototype)

public static Evaluation.EvaluationSpec.Builder newBuilder(Evaluation.EvaluationSpec prototype)
Parameter
Name Description
prototype Evaluation.EvaluationSpec
Returns
Type Description
Evaluation.EvaluationSpec.Builder

parseDelimitedFrom(InputStream input)

public static Evaluation.EvaluationSpec parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.EvaluationSpec parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Evaluation.EvaluationSpec parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.EvaluationSpec parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Evaluation.EvaluationSpec parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.EvaluationSpec parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Evaluation.EvaluationSpec parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.EvaluationSpec parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Evaluation.EvaluationSpec parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Evaluation.EvaluationSpec parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Evaluation.EvaluationSpec parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Evaluation.EvaluationSpec parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Evaluation.EvaluationSpec
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Evaluation.EvaluationSpec> parser()
Returns
Type Description
Parser<EvaluationSpec>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

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

getParserForType()

public Parser<Evaluation.EvaluationSpec> getParserForType()
Returns
Type Description
Parser<EvaluationSpec>
Overrides

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.

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Evaluation.EvaluationSpec.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Evaluation.EvaluationSpec.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException