Class GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder (0.50.0)

Version 0.50.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder extends GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder> implements GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder

Message to be used for grounding with Vertex AI Search.

Protobuf type google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GroundingSource.SearchSource

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Implements

GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder

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

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

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

build()

public GenerateGroundedContentRequest.GroundingSource.SearchSource build()

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource

buildPartial()

public GenerateGroundedContentRequest.GroundingSource.SearchSource buildPartial()

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource

clear()

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clear()

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

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

clearFilter()

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearFilter()

Filter expression to be applied to the search.

The syntax is the same as SearchRequest.filter.

string filter = 3;

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	This builder for chaining.

clearMaxResultCount()

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearMaxResultCount()

Number of search results to return.

The default value is 10. The maximumm allowed value is 10.

int32 max_result_count = 2;

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

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

clearSafeSearch()

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearSafeSearch()

If set, safe search is enabled in Vertex AI Search requests.

bool safe_search = 5;

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	This builder for chaining.

clearServingConfig()

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearServingConfig()

The resource name of the Engine to use.

Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}

string serving_config = 1 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	This builder for chaining.

clone()

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clone()

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public GenerateGroundedContentRequest.GroundingSource.SearchSource getDefaultInstanceForType()

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

Filter expression to be applied to the search.

The syntax is the same as SearchRequest.filter.

string filter = 3;

Returns
Type	Description
String	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Filter expression to be applied to the search.

The syntax is the same as SearchRequest.filter.

string filter = 3;

Returns
Type	Description
ByteString	The bytes for filter.

getMaxResultCount()

public int getMaxResultCount()

Number of search results to return.

The default value is 10. The maximumm allowed value is 10.

int32 max_result_count = 2;

Returns
Type	Description
int	The maxResultCount.

getSafeSearch()

public boolean getSafeSearch()

If set, safe search is enabled in Vertex AI Search requests.

bool safe_search = 5;

Returns
Type	Description
boolean	The safeSearch.

getServingConfig()

public String getServingConfig()

The resource name of the Engine to use.

Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}

string serving_config = 1 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The servingConfig.

getServingConfigBytes()

public ByteString getServingConfigBytes()

The resource name of the Engine to use.

Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}

string serving_config = 1 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for servingConfig.

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(GenerateGroundedContentRequest.GroundingSource.SearchSource other)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder mergeFrom(GenerateGroundedContentRequest.GroundingSource.SearchSource other)

Parameter
Name	Description
other	GenerateGroundedContentRequest.GroundingSource.SearchSource

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

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

setFilter(String value)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setFilter(String value)

Filter expression to be applied to the search.

The syntax is the same as SearchRequest.filter.

string filter = 3;

Parameter
Name	Description
value	String The filter to set.

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	This builder for chaining.

setFilterBytes(ByteString value)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setFilterBytes(ByteString value)

Filter expression to be applied to the search.

The syntax is the same as SearchRequest.filter.

string filter = 3;

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

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	This builder for chaining.

setMaxResultCount(int value)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setMaxResultCount(int value)

Number of search results to return.

The default value is 10. The maximumm allowed value is 10.

int32 max_result_count = 2;

Parameter
Name	Description
value	int The maxResultCount to set.

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	This builder for chaining.

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

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

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

setSafeSearch(boolean value)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setSafeSearch(boolean value)

If set, safe search is enabled in Vertex AI Search requests.

bool safe_search = 5;

Parameter
Name	Description
value	boolean The safeSearch to set.

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	This builder for chaining.

setServingConfig(String value)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setServingConfig(String value)

The resource name of the Engine to use.

Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}

string serving_config = 1 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
value	String The servingConfig to set.

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	This builder for chaining.

setServingConfigBytes(ByteString value)

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setServingConfigBytes(ByteString value)

The resource name of the Engine to use.

Format: projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}

string serving_config = 1 [(.google.api.resource_reference) = { ... }

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

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

Overrides

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