Class VertexRanker.Builder (0.1.0)

public static final class VertexRanker.Builder extends GeneratedMessageV3.Builder<VertexRanker.Builder> implements VertexRankerOrBuilder

Defines a ranker using the Vertex AI ranking service. See https://cloud.google.com/generative-ai-app-builder/docs/ranking for details.

Protobuf type google.cloud.vectorsearch.v1beta.VertexRanker

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > VertexRanker.Builder

Implements

VertexRankerOrBuilder

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 VertexRanker.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
VertexRanker.Builder

Overrides

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

build()

public VertexRanker build()

Returns
Type	Description
VertexRanker

buildPartial()

public VertexRanker buildPartial()

Returns
Type	Description
VertexRanker

clear()

public VertexRanker.Builder clear()

Returns
Type	Description
VertexRanker.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearContentTemplate()

public VertexRanker.Builder clearContentTemplate()

Optional. The template used to generate the record's content.

string content_template = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public VertexRanker.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
VertexRanker.Builder

Overrides

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

clearModel()

public VertexRanker.Builder clearModel()

Required. The model used for ranking documents. If no model is specified, then semantic-ranker-default@latest is used.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public VertexRanker.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
VertexRanker.Builder

Overrides

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

clearQuery()

public VertexRanker.Builder clearQuery()

Required. The query against which the records are ranked and scored.

string query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

clearTitleTemplate()

public VertexRanker.Builder clearTitleTemplate()

Optional. The template used to generate the record's title.

string title_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

clone()

public VertexRanker.Builder clone()

Returns
Type	Description
VertexRanker.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getContentTemplate()

public String getContentTemplate()

Optional. The template used to generate the record's content.

string content_template = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The contentTemplate.

getContentTemplateBytes()

public ByteString getContentTemplateBytes()

Optional. The template used to generate the record's content.

string content_template = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for contentTemplate.

getDefaultInstanceForType()

public VertexRanker getDefaultInstanceForType()

Returns
Type	Description
VertexRanker

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getModel()

public String getModel()

Required. The model used for ranking documents. If no model is specified, then semantic-ranker-default@latest is used.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The model.

getModelBytes()

public ByteString getModelBytes()

Required. The model used for ranking documents. If no model is specified, then semantic-ranker-default@latest is used.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for model.

getQuery()

public String getQuery()

Required. The query against which the records are ranked and scored.

string query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The query.

getQueryBytes()

public ByteString getQueryBytes()

Required. The query against which the records are ranked and scored.

string query = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for query.

getTitleTemplate()

public String getTitleTemplate()

Optional. The template used to generate the record's title.

string title_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The titleTemplate.

getTitleTemplateBytes()

public ByteString getTitleTemplateBytes()

Optional. The template used to generate the record's title.

string title_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for titleTemplate.

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

public VertexRanker.Builder mergeFrom(VertexRanker other)

Parameter
Name	Description
other	VertexRanker

Returns
Type	Description
VertexRanker.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public VertexRanker.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
VertexRanker.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public VertexRanker.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
VertexRanker.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final VertexRanker.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
VertexRanker.Builder

Overrides

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

setContentTemplate(String value)

public VertexRanker.Builder setContentTemplate(String value)

Optional. The template used to generate the record's content.

string content_template = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The contentTemplate to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

setContentTemplateBytes(ByteString value)

public VertexRanker.Builder setContentTemplateBytes(ByteString value)

Optional. The template used to generate the record's content.

string content_template = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for contentTemplate to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public VertexRanker.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
VertexRanker.Builder

Overrides

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

setModel(String value)

public VertexRanker.Builder setModel(String value)

Required. The model used for ranking documents. If no model is specified, then semantic-ranker-default@latest is used.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The model to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

setModelBytes(ByteString value)

public VertexRanker.Builder setModelBytes(ByteString value)

Required. The model used for ranking documents. If no model is specified, then semantic-ranker-default@latest is used.

string model = 4 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for model to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

setQuery(String value)

public VertexRanker.Builder setQuery(String value)

Required. The query against which the records are ranked and scored.

string query = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	String The query to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

setQueryBytes(ByteString value)

public VertexRanker.Builder setQueryBytes(ByteString value)

Required. The query against which the records are ranked and scored.

string query = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
value	ByteString The bytes for query to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

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

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

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
VertexRanker.Builder

Overrides

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

setTitleTemplate(String value)

public VertexRanker.Builder setTitleTemplate(String value)

Optional. The template used to generate the record's title.

string title_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	String The titleTemplate to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

setTitleTemplateBytes(ByteString value)

public VertexRanker.Builder setTitleTemplateBytes(ByteString value)

Optional. The template used to generate the record's title.

string title_template = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
value	ByteString The bytes for titleTemplate to set.

Returns
Type	Description
VertexRanker.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final VertexRanker.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
VertexRanker.Builder

Overrides

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