com.google.cloud.discoveryengine.v1beta

Class GenerateGroundedContentRequest.GroundingSource.SearchSource

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

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

All Implemented Interfaces:

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

Enclosing class:

GenerateGroundedContentRequest.GroundingSource

public static final class GenerateGroundedContentRequest.GroundingSource.SearchSource
extends com.google.protobuf.GeneratedMessageV3
implements GenerateGroundedContentRequest.GroundingSource.SearchSourceOrBuilder

 Message to be used for grounding with Vertex AI Search.
 

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder Message to be used for grounding with Vertex AI Search.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FILTER_FIELD_NUMBER
static int	MAX_RESULT_COUNT_FIELD_NUMBER
static int	SAFE_SEARCH_FIELD_NUMBER
static int	SERVING_CONFIG_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	getDefaultInstance()
GenerateGroundedContentRequest.GroundingSource.SearchSource	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.Parser<GenerateGroundedContentRequest.GroundingSource.SearchSource>	getParserForType()
boolean	getSafeSearch() If set, safe search is enabled in Vertex AI Search requests.
int	getSerializedSize()
String	getServingConfig() The resource name of the Engine to use.
com.google.protobuf.ByteString	getServingConfigBytes() The resource name of the Engine to use.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	newBuilder()
static GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	newBuilder(GenerateGroundedContentRequest.GroundingSource.SearchSource prototype)
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	newBuilderForType()
protected GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseDelimitedFrom(InputStream input)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseFrom(byte[] data)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseFrom(ByteBuffer data)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseFrom(com.google.protobuf.ByteString data)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseFrom(com.google.protobuf.CodedInputStream input)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseFrom(InputStream input)
static GenerateGroundedContentRequest.GroundingSource.SearchSource	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerateGroundedContentRequest.GroundingSource.SearchSource>	parser()
GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

SERVING_CONFIG_FIELD_NUMBER

public static final int SERVING_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

MAX_RESULT_COUNT_FIELD_NUMBER

public static final int MAX_RESULT_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

FILTER_FIELD_NUMBER

public static final int FILTER_FIELD_NUMBER

See Also:

Constant Field Values

SAFE_SEARCH_FIELD_NUMBER

public static final int SAFE_SEARCH_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

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

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.

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.

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.

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.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(ByteBuffer data)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(ByteBuffer data,
                                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(com.google.protobuf.ByteString data)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(com.google.protobuf.ByteString data,
                                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(byte[] data)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(byte[] data,
                                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(InputStream input)
                                                                             throws IOException

Throws:

IOException

parseFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(InputStream input,
                                                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseDelimitedFrom(InputStream input)
                                                                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseDelimitedFrom(InputStream input,
                                                                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                                      throws IOException

Throws:

IOException

parseFrom

public static GenerateGroundedContentRequest.GroundingSource.SearchSource parseFrom(com.google.protobuf.CodedInputStream input)
                                                                             throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder newBuilder()

newBuilder

public static GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder newBuilder(GenerateGroundedContentRequest.GroundingSource.SearchSource prototype)

toBuilder

public GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GenerateGroundedContentRequest.GroundingSource.SearchSource.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GenerateGroundedContentRequest.GroundingSource.SearchSource getDefaultInstance()

parser

public static com.google.protobuf.Parser<GenerateGroundedContentRequest.GroundingSource.SearchSource> parser()

getParserForType

public com.google.protobuf.Parser<GenerateGroundedContentRequest.GroundingSource.SearchSource> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public GenerateGroundedContentRequest.GroundingSource.SearchSource getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder