com.google.cloud.discoveryengine.v1beta

Class GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

com.google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder

All Implemented Interfaces:

GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

GenerateGroundedContentRequest.GroundingSource.SearchSource

public static final class GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder
extends com.google.protobuf.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.v1beta.GenerateGroundedContentRequest.GroundingSource.SearchSource

Method Summary

Modifier and Type	Method and Description
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
GenerateGroundedContentRequest.GroundingSource.SearchSource	build()
GenerateGroundedContentRequest.GroundingSource.SearchSource	buildPartial()
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	clear()
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	clearFilter() Filter expression to be applied to the search.
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	clearMaxResultCount() Number of search results to return.
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	clearSafeSearch() If set, safe search is enabled in Vertex AI Search requests.
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	clearServingConfig() The resource name of the Engine to use.
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	clone()
GenerateGroundedContentRequest.GroundingSource.SearchSource	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getFilter() Filter expression to be applied to the search.
com.google.protobuf.ByteString	getFilterBytes() Filter expression to be applied to the search.
int	getMaxResultCount() Number of search results to return.
boolean	getSafeSearch() If set, safe search is enabled in Vertex AI Search requests.
String	getServingConfig() The resource name of the Engine to use.
com.google.protobuf.ByteString	getServingConfigBytes() The resource name of the Engine to use.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	mergeFrom(GenerateGroundedContentRequest.GroundingSource.SearchSource other)
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	mergeFrom(com.google.protobuf.Message other)
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	setFilter(String value) Filter expression to be applied to the search.
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	setFilterBytes(com.google.protobuf.ByteString value) Filter expression to be applied to the search.
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	setMaxResultCount(int value) Number of search results to return.
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	setSafeSearch(boolean value) If set, safe search is enabled in Vertex AI Search requests.
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	setServingConfig(String value) The resource name of the Engine to use.
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	setServingConfigBytes(com.google.protobuf.ByteString value) The resource name of the Engine to use.
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

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.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

clear

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

getDefaultInstanceForType

public GenerateGroundedContentRequest.GroundingSource.SearchSource getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public GenerateGroundedContentRequest.GroundingSource.SearchSource build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public GenerateGroundedContentRequest.GroundingSource.SearchSource buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

setField

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

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

clearField

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

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

clearOneof

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

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

addRepeatedField

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                                                            Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

mergeFrom

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

mergeFrom

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                                                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                              throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

Throws:

IOException

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) = { ... }

Specified by:

getServingConfig in interface GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder

Returns:

The servingConfig.

getServingConfigBytes

public com.google.protobuf.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) = { ... }

Specified by:

getServingConfigBytes in interface GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder

Returns:

The bytes for servingConfig.

setServingConfig

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) = { ... }

Parameters:

value - The servingConfig to set.

Returns:

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:

This builder for chaining.

setServingConfigBytes

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setServingConfigBytes(com.google.protobuf.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) = { ... }

Parameters:

value - The bytes for servingConfig to set.

Returns:

This builder for chaining.

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;

Specified by:

getMaxResultCount in interface GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder

Returns:

The maxResultCount.

setMaxResultCount

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;

Parameters:

value - The maxResultCount to set.

Returns:

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:

This builder for chaining.

getFilter

public String getFilter()

 Filter expression to be applied to the search.

 The syntax is the same as
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter].
 

string filter = 3;

Specified by:

getFilter in interface GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder

Returns:

The filter.

getFilterBytes

public com.google.protobuf.ByteString getFilterBytes()

 Filter expression to be applied to the search.

 The syntax is the same as
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter].
 

string filter = 3;

Specified by:

getFilterBytes in interface GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder

Returns:

The bytes for filter.

setFilter

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

 Filter expression to be applied to the search.

 The syntax is the same as
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter].
 

string filter = 3;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearFilter()

 Filter expression to be applied to the search.

 The syntax is the same as
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter].
 

string filter = 3;

Returns:

This builder for chaining.

setFilterBytes

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder setFilterBytes(com.google.protobuf.ByteString value)

 Filter expression to be applied to the search.

 The syntax is the same as
 [SearchRequest.filter][google.cloud.discoveryengine.v1beta.SearchRequest.filter].
 

string filter = 3;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

getSafeSearch

public boolean getSafeSearch()

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

bool safe_search = 5;

Specified by:

getSafeSearch in interface GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder

Returns:

The safeSearch.

setSafeSearch

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

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

bool safe_search = 5;

Parameters:

value - The safeSearch to set.

Returns:

This builder for chaining.

clearSafeSearch

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder clearSafeSearch()

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

bool safe_search = 5;

Returns:

This builder for chaining.

setUnknownFields

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

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>

mergeUnknownFields

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

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder>