public final class GoogleSearchTool extends GeneratedMessage implements GoogleSearchToolOrBuilder
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
CONTEXT_URLS_FIELD_NUMBER
public static final int CONTEXT_URLS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXCLUDE_DOMAINS_FIELD_NUMBER
public static final int EXCLUDE_DOMAINS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PREFERRED_DOMAINS_FIELD_NUMBER
public static final int PREFERRED_DOMAINS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int PROMPT_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static GoogleSearchTool getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static GoogleSearchTool.Builder newBuilder()
public static GoogleSearchTool.Builder newBuilder(GoogleSearchTool prototype)
public static GoogleSearchTool parseDelimitedFrom(InputStream input)
public static GoogleSearchTool parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GoogleSearchTool parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static GoogleSearchTool parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GoogleSearchTool parseFrom(ByteString data)
public static GoogleSearchTool parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GoogleSearchTool parseFrom(CodedInputStream input)
public static GoogleSearchTool parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GoogleSearchTool parseFrom(InputStream input)
public static GoogleSearchTool parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GoogleSearchTool parseFrom(ByteBuffer data)
public static GoogleSearchTool parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<GoogleSearchTool> parser()
Methods
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getContextUrls(int index)
public String getContextUrls(int index)
Optional. Content will be fetched directly from these URLs for context and
grounding. Example: "https://example.com/path.html". A maximum of 20 URLs
are allowed.
repeated string context_urls = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The contextUrls at the given index.
|
getContextUrlsBytes(int index)
public ByteString getContextUrlsBytes(int index)
Optional. Content will be fetched directly from these URLs for context and
grounding. Example: "https://example.com/path.html". A maximum of 20 URLs
are allowed.
repeated string context_urls = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the contextUrls at the given index.
|
getContextUrlsCount()
public int getContextUrlsCount()
Optional. Content will be fetched directly from these URLs for context and
grounding. Example: "https://example.com/path.html". A maximum of 20 URLs
are allowed.
repeated string context_urls = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The count of contextUrls.
|
getContextUrlsList()
public ProtocolStringList getContextUrlsList()
Optional. Content will be fetched directly from these URLs for context and
grounding. Example: "https://example.com/path.html". A maximum of 20 URLs
are allowed.
repeated string context_urls = 3 [(.google.api.field_behavior) = OPTIONAL];
public GoogleSearchTool getDefaultInstanceForType()
public String getDescription()
Optional. Description of the tool's purpose.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The description.
|
public ByteString getDescriptionBytes()
Optional. Description of the tool's purpose.
string description = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getExcludeDomains(int index)
public String getExcludeDomains(int index)
Optional. List of domains to be excluded from the search results.
Example: "example.com".
A maximum of 2000 domains can be excluded.
repeated string exclude_domains = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The excludeDomains at the given index.
|
getExcludeDomainsBytes(int index)
public ByteString getExcludeDomainsBytes(int index)
Optional. List of domains to be excluded from the search results.
Example: "example.com".
A maximum of 2000 domains can be excluded.
repeated string exclude_domains = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the excludeDomains at the given index.
|
getExcludeDomainsCount()
public int getExcludeDomainsCount()
Optional. List of domains to be excluded from the search results.
Example: "example.com".
A maximum of 2000 domains can be excluded.
repeated string exclude_domains = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The count of excludeDomains.
|
getExcludeDomainsList()
public ProtocolStringList getExcludeDomainsList()
Optional. List of domains to be excluded from the search results.
Example: "example.com".
A maximum of 2000 domains can be excluded.
repeated string exclude_domains = 4 [(.google.api.field_behavior) = OPTIONAL];
Required. The name of the tool.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Required. The name of the tool.
string name = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public Parser<GoogleSearchTool> getParserForType()
Overrides
getPreferredDomains(int index)
public String getPreferredDomains(int index)
Optional. Specifies domains to restrict search results to.
Example: "example.com", "another.site". A maximum of 20 domains can be
specified.
repeated string preferred_domains = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the element to return.
|
| Returns |
| Type |
Description |
String |
The preferredDomains at the given index.
|
getPreferredDomainsBytes(int index)
public ByteString getPreferredDomainsBytes(int index)
Optional. Specifies domains to restrict search results to.
Example: "example.com", "another.site". A maximum of 20 domains can be
specified.
repeated string preferred_domains = 6 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
index |
int
The index of the value to return.
|
| Returns |
| Type |
Description |
ByteString |
The bytes of the preferredDomains at the given index.
|
getPreferredDomainsCount()
public int getPreferredDomainsCount()
Optional. Specifies domains to restrict search results to.
Example: "example.com", "another.site". A maximum of 20 domains can be
specified.
repeated string preferred_domains = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The count of preferredDomains.
|
getPreferredDomainsList()
public ProtocolStringList getPreferredDomainsList()
Optional. Specifies domains to restrict search results to.
Example: "example.com", "another.site". A maximum of 20 domains can be
specified.
repeated string preferred_domains = 6 [(.google.api.field_behavior) = OPTIONAL];
public GoogleSearchTool.PromptConfig getPromptConfig()
Optional. Prompt instructions passed to planner on how the search results
should be processed for text and voice.
.google.cloud.ces.v1.GoogleSearchTool.PromptConfig prompt_config = 5 [(.google.api.field_behavior) = OPTIONAL];
public GoogleSearchTool.PromptConfigOrBuilder getPromptConfigOrBuilder()
Optional. Prompt instructions passed to planner on how the search results
should be processed for text and voice.
.google.cloud.ces.v1.GoogleSearchTool.PromptConfig prompt_config = 5 [(.google.api.field_behavior) = OPTIONAL];
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public boolean hasPromptConfig()
Optional. Prompt instructions passed to planner on how the search results
should be processed for text and voice.
.google.cloud.ces.v1.GoogleSearchTool.PromptConfig prompt_config = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the promptConfig field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
public final boolean isInitialized()
Overrides
public GoogleSearchTool.Builder newBuilderForType()
protected GoogleSearchTool.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
public GoogleSearchTool.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
