Class SampleQuery.QueryEntry.Target (0.51.0)

public static final class SampleQuery.QueryEntry.Target extends GeneratedMessageV3 implements SampleQuery.QueryEntry.TargetOrBuilder

Defines the parameters of the query's expected outcome.

Protobuf type google.cloud.discoveryengine.v1alpha.SampleQuery.QueryEntry.Target

Static Fields

PAGE_NUMBERS_FIELD_NUMBER

public static final int PAGE_NUMBERS_FIELD_NUMBER
Field Value
Type Description
int

SCORE_FIELD_NUMBER

public static final int SCORE_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SampleQuery.QueryEntry.Target getDefaultInstance()
Returns
Type Description
SampleQuery.QueryEntry.Target

getDescriptor()

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

newBuilder()

public static SampleQuery.QueryEntry.Target.Builder newBuilder()
Returns
Type Description
SampleQuery.QueryEntry.Target.Builder

newBuilder(SampleQuery.QueryEntry.Target prototype)

public static SampleQuery.QueryEntry.Target.Builder newBuilder(SampleQuery.QueryEntry.Target prototype)
Parameter
Name Description
prototype SampleQuery.QueryEntry.Target
Returns
Type Description
SampleQuery.QueryEntry.Target.Builder

parseDelimitedFrom(InputStream input)

public static SampleQuery.QueryEntry.Target parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SampleQuery.QueryEntry.Target parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SampleQuery.QueryEntry.Target parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static SampleQuery.QueryEntry.Target parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SampleQuery.QueryEntry.Target parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SampleQuery.QueryEntry.Target parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SampleQuery.QueryEntry.Target parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SampleQuery.QueryEntry.Target parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SampleQuery.QueryEntry.Target parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SampleQuery.QueryEntry.Target parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SampleQuery.QueryEntry.Target parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SampleQuery.QueryEntry.Target
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SampleQuery.QueryEntry.Target> parser()
Returns
Type Description
Parser<Target>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SampleQuery.QueryEntry.Target getDefaultInstanceForType()
Returns
Type Description
SampleQuery.QueryEntry.Target

getPageNumbers(int index)

public int getPageNumbers(int index)

Expected page numbers of the target.

Each page number must be non negative.

repeated int32 page_numbers = 2;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
int

The pageNumbers at the given index.

getPageNumbersCount()

public int getPageNumbersCount()

Expected page numbers of the target.

Each page number must be non negative.

repeated int32 page_numbers = 2;

Returns
Type Description
int

The count of pageNumbers.

getPageNumbersList()

public List<Integer> getPageNumbersList()

Expected page numbers of the target.

Each page number must be non negative.

repeated int32 page_numbers = 2;

Returns
Type Description
List<Integer>

A list containing the pageNumbers.

getParserForType()

public Parser<SampleQuery.QueryEntry.Target> getParserForType()
Returns
Type Description
Parser<Target>
Overrides

getScore()

public double getScore()

Relevance score of the target.

optional double score = 3;

Returns
Type Description
double

The score.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUri()

public String getUri()

Expected uri of the target.

This field must be a UTF-8 encoded string with a length limit of 2048 characters.

Example of valid uris: https://example.com/abc, gcs://example/example.pdf.

string uri = 1;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

Expected uri of the target.

This field must be a UTF-8 encoded string with a length limit of 2048 characters.

Example of valid uris: https://example.com/abc, gcs://example/example.pdf.

string uri = 1;

Returns
Type Description
ByteString

The bytes for uri.

hasScore()

public boolean hasScore()

Relevance score of the target.

optional double score = 3;

Returns
Type Description
boolean

Whether the score 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 SampleQuery.QueryEntry.Target.Builder newBuilderForType()
Returns
Type Description
SampleQuery.QueryEntry.Target.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SampleQuery.QueryEntry.Target.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SampleQuery.QueryEntry.Target.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public SampleQuery.QueryEntry.Target.Builder toBuilder()
Returns
Type Description
SampleQuery.QueryEntry.Target.Builder

writeTo(CodedOutputStream output)

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