Interface SearchAgentsRequestOrBuilder (0.2.0)

public interface SearchAgentsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getPageSize()

public abstract int getPageSize()

Optional. The maximum number of search results to return per page. The page size is capped at 100, even if a larger value is specified. A negative value will result in an INVALID_ARGUMENT error. If unspecified or set to 0, a default value of 20 will be used. The server may return fewer results than requested.

int32 page_size = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`int`	The pageSize.

getPageToken()

public abstract String getPageToken()

Optional. If present, retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of all other method parameters, must be identical to those in the previous call.

string page_token = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`String`	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

string page_token = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`ByteString`	The bytes for pageToken.

getParent()

public abstract String getParent()

Required. Parent value for SearchAgentsRequest. Format: projects/{project}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. Parent value for SearchAgentsRequest. Format: projects/{project}/locations/{location}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for parent.

getSearchString()

public abstract String getSearchString()

Optional. Search criteria used to select the Agents to return. If no search criteria is specified then all accessible Agents will be returned.

Search expressions can be used to restrict results based upon searchable fields, where the operators can be used along with the suffix wildcard symbol *. See instructions for more details.

Allowed operators: =, :, NOT, AND, OR, and ().

Searchable fields:

Field	`=`	`:`	`*`	Keyword Search
agentId	Yes	Yes	Yes	Included
name	No	Yes	Yes	Included
displayName	No	Yes	Yes	Included
description	No	Yes	No	Included
skills	No	Yes	No	Included
skills.id	No	Yes	No	Included
skills.name	No	Yes	No	Included
skills.description	No	Yes	No	Included
skills.tags	No	Yes	No	Included
skills.examples	No	Yes	No	Included

Examples:

agentId="urn:agent:projects-123:projects:123:locations:us-central1:reasoningEngines:1234" to find the agent with the specified agent ID.
name:important to find agents whose name contains important as a word.
displayName:works* to find agents whose display name contains words that start with works.
skills.tags:test to find agents whose skills tags contain test.
planner OR booking to find agents whose metadata contains the words planner or booking.

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

Returns
Type	Description
`String`	The searchString.

getSearchStringBytes()

public abstract ByteString getSearchStringBytes()