Class ExecuteToolRequest (0.3.0)

0.3.0 (latest) 0.1.0

public final class ExecuteToolRequest extends GeneratedMessage implements ExecuteToolRequestOrBuilder

Request message for ToolService.ExecuteTool.

Protobuf type google.cloud.ces.v1beta.ExecuteToolRequest

Inheritance

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

Implements

ExecuteToolRequestOrBuilder

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

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER

Field Value
Type	Description
int

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER

Field Value
Type	Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

Field Value
Type	Description
int

TOOLSET_TOOL_FIELD_NUMBER

public static final int TOOLSET_TOOL_FIELD_NUMBER

Field Value
Type	Description
int

TOOL_FIELD_NUMBER

public static final int TOOL_FIELD_NUMBER

Field Value
Type	Description
int

VARIABLES_FIELD_NUMBER

public static final int VARIABLES_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static ExecuteToolRequest getDefaultInstance()

Returns
Type	Description
ExecuteToolRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static ExecuteToolRequest.Builder newBuilder()

Returns
Type	Description
ExecuteToolRequest.Builder

newBuilder(ExecuteToolRequest prototype)

public static ExecuteToolRequest.Builder newBuilder(ExecuteToolRequest prototype)

Parameter
Name	Description
prototype	ExecuteToolRequest

Returns
Type	Description
ExecuteToolRequest.Builder

parseDelimitedFrom(InputStream input)

public static ExecuteToolRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static ExecuteToolRequest parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecuteToolRequest parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecuteToolRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static ExecuteToolRequest parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static ExecuteToolRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
ExecuteToolRequest

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<ExecuteToolRequest> parser()

Returns
Type	Description
Parser<ExecuteToolRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getArgs()

public Struct getArgs()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The args.

getArgsOrBuilder()

public StructOrBuilder getArgsOrBuilder()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

getContext()

public Struct getContext()

Optional. The ToolCallContext to be passed to the Python tool.

.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The context.

getContextOrBuilder()

public StructOrBuilder getContextOrBuilder()

Optional. The ToolCallContext to be passed to the Python tool.

.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

getDefaultInstanceForType()

public ExecuteToolRequest getDefaultInstanceForType()

Returns
Type	Description
ExecuteToolRequest

getParent()

public String getParent()

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

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

Returns
Type	Description
String	The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

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

Returns
Type	Description
ByteString	The bytes for parent.

getParserForType()

public Parser<ExecuteToolRequest> getParserForType()

Returns
Type	Description
Parser<ExecuteToolRequest>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getTool()

public String getTool()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The tool.

getToolBytes()

public ByteString getToolBytes()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for tool.

getToolExecutionContextCase()

public ExecuteToolRequest.ToolExecutionContextCase getToolExecutionContextCase()

Returns
Type	Description
ExecuteToolRequest.ToolExecutionContextCase

getToolIdentifierCase()

public ExecuteToolRequest.ToolIdentifierCase getToolIdentifierCase()

Returns
Type	Description
ExecuteToolRequest.ToolIdentifierCase

getToolsetTool()

public ToolsetTool getToolsetTool()

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ToolsetTool	The toolsetTool.

getToolsetToolOrBuilder()

public ToolsetToolOrBuilder getToolsetToolOrBuilder()

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ToolsetToolOrBuilder

getVariables()

public Struct getVariables()

Optional. The variables that are available for the tool execution.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Struct	The variables.

getVariablesOrBuilder()

public StructOrBuilder getVariablesOrBuilder()

Optional. The variables that are available for the tool execution.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
StructOrBuilder

hasArgs()

public boolean hasArgs()

Optional. The input parameters and values for the tool in JSON object format.

.google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the args field is set.

hasContext()

public boolean hasContext()

Optional. The ToolCallContext to be passed to the Python tool.

.google.protobuf.Struct context = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the context field is set.

hasTool()

public boolean hasTool()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type	Description
boolean	Whether the tool field is set.

hasToolsetTool()

public boolean hasToolsetTool()

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1beta.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the toolsetTool field is set.

hasVariables()

public boolean hasVariables()

Optional. The variables that are available for the tool execution.

.google.protobuf.Struct variables = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the variables field is set.

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 ExecuteToolRequest.Builder newBuilderForType()

Returns
Type	Description
ExecuteToolRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ExecuteToolRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
ExecuteToolRequest.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public ExecuteToolRequest.Builder toBuilder()

Returns
Type	Description
ExecuteToolRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException