Class SearchAgentsRequest.Builder (0.2.0)

0.2.0 (latest) 0.1.0

public static final class SearchAgentsRequest.Builder extends GeneratedMessage.Builder<SearchAgentsRequest.Builder> implements SearchAgentsRequestOrBuilder

Message for searching Agents

Protobuf type google.cloud.agentregistry.v1.SearchAgentsRequest

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchAgentsRequest.Builder

Implements

SearchAgentsRequestOrBuilder

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)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.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

build()

public SearchAgentsRequest build()

Returns
Type	Description
SearchAgentsRequest

buildPartial()

public SearchAgentsRequest buildPartial()

Returns
Type	Description
SearchAgentsRequest

clear()

public SearchAgentsRequest.Builder clear()

Returns
Type	Description
SearchAgentsRequest.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearPageSize()

public SearchAgentsRequest.Builder clearPageSize()

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
SearchAgentsRequest.Builder	This builder for chaining.

clearPageToken()

public SearchAgentsRequest.Builder clearPageToken()

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
SearchAgentsRequest.Builder	This builder for chaining.

clearParent()

public SearchAgentsRequest.Builder clearParent()

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
SearchAgentsRequest.Builder	This builder for chaining.

clearSearchString()

public SearchAgentsRequest.Builder clearSearchString()

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
SearchAgentsRequest.Builder	This builder for chaining.

getDefaultInstanceForType()

public SearchAgentsRequest getDefaultInstanceForType()

Returns
Type	Description
SearchAgentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

getPageSize()

public 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 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 ByteString getPageTokenBytes()

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
ByteString	The bytes for pageToken.

getParent()

public 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 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 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 ByteString getSearchStringBytes()

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
ByteString	The bytes for searchString.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(SearchAgentsRequest other)

public SearchAgentsRequest.Builder mergeFrom(SearchAgentsRequest other)

Parameter
Name	Description
other	SearchAgentsRequest

Returns
Type	Description
SearchAgentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchAgentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchAgentsRequest.Builder

Overrides

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

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SearchAgentsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SearchAgentsRequest.Builder

Overrides

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

setPageSize(int value)

public SearchAgentsRequest.Builder setPageSize(int value)

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];

Parameter
Name	Description
value	int The pageSize to set.

Returns
Type	Description
SearchAgentsRequest.Builder	This builder for chaining.

setPageToken(String value)

public SearchAgentsRequest.Builder setPageToken(String value)

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];

Parameter
Name	Description
value	String The pageToken to set.

Returns
Type	Description
SearchAgentsRequest.Builder	This builder for chaining.

setPageTokenBytes(ByteString value)

public SearchAgentsRequest.Builder setPageTokenBytes(ByteString value)

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];

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

Returns
Type	Description
SearchAgentsRequest.Builder	This builder for chaining.

setParent(String value)

public SearchAgentsRequest.Builder setParent(String value)

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

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

Parameter
Name	Description
value	String The parent to set.

Returns
Type	Description
SearchAgentsRequest.Builder	This builder for chaining.

setParentBytes(ByteString value)

public SearchAgentsRequest.Builder setParentBytes(ByteString value)

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

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

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

Returns
Type	Description
SearchAgentsRequest.Builder	This builder for chaining.

setSearchString(String value)

public SearchAgentsRequest.Builder setSearchString(String value)

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];

Parameter
Name	Description
value	String The searchString to set.

Returns
Type	Description
SearchAgentsRequest.Builder	This builder for chaining.

setSearchStringBytes(ByteString value)

public SearchAgentsRequest.Builder setSearchStringBytes(ByteString value)

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];

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

Returns
Type	Description
SearchAgentsRequest.Builder	This builder for chaining.