Class SearchAgentsRequest (0.2.0)

0.2.0 (latest) 0.1.0

public final class SearchAgentsRequest extends GeneratedMessage implements SearchAgentsRequestOrBuilder

Message for searching Agents

Protobuf type google.cloud.agentregistry.v1.SearchAgentsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SearchAgentsRequest

Implements

SearchAgentsRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

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)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

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()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

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()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

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

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER

Field Value
Type	Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

Field Value
Type	Description
int

SEARCH_STRING_FIELD_NUMBER

public static final int SEARCH_STRING_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static SearchAgentsRequest getDefaultInstance()

Returns
Type	Description
SearchAgentsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static SearchAgentsRequest.Builder newBuilder()

Returns
Type	Description
SearchAgentsRequest.Builder

newBuilder(SearchAgentsRequest prototype)

public static SearchAgentsRequest.Builder newBuilder(SearchAgentsRequest prototype)

Parameter
Name	Description
prototype	SearchAgentsRequest

Returns
Type	Description
SearchAgentsRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchAgentsRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchAgentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static SearchAgentsRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchAgentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchAgentsRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchAgentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchAgentsRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchAgentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static SearchAgentsRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchAgentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static SearchAgentsRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchAgentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
SearchAgentsRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<SearchAgentsRequest> parser()

Returns
Type	Description
Parser<SearchAgentsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public SearchAgentsRequest getDefaultInstanceForType()

Returns
Type	Description
SearchAgentsRequest

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.

getParserForType()

public Parser<SearchAgentsRequest> getParserForType()

Returns
Type	Description
Parser<SearchAgentsRequest>

Overrides

GeneratedMessage.getParserForType()

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.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public SearchAgentsRequest.Builder newBuilderForType()

Returns
Type	Description
SearchAgentsRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchAgentsRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
SearchAgentsRequest.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public SearchAgentsRequest.Builder toBuilder()

Returns
Type	Description
SearchAgentsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException