com.google.cloud.aiplatform.v1beta1

Class ToolUseExample

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.ToolUseExample

All Implemented Interfaces:

ToolUseExampleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ToolUseExample
extends com.google.protobuf.GeneratedMessageV3
implements ToolUseExampleOrBuilder

 A single example of the tool usage.
 

Protobuf type google.cloud.aiplatform.v1beta1.ToolUseExample

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ToolUseExample.Builder A single example of the tool usage.
static class	ToolUseExample.ExtensionOperation Identifies one operation of the extension.
static interface	ToolUseExample.ExtensionOperationOrBuilder
static class	ToolUseExample.TargetCase

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DISPLAY_NAME_FIELD_NUMBER
static int	EXTENSION_OPERATION_FIELD_NUMBER
static int	FUNCTION_NAME_FIELD_NUMBER
static int	QUERY_FIELD_NUMBER
static int	REQUEST_PARAMS_FIELD_NUMBER
static int	RESPONSE_PARAMS_FIELD_NUMBER
static int	RESPONSE_SUMMARY_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static ToolUseExample	getDefaultInstance()
ToolUseExample	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
ToolUseExample.ExtensionOperation	getExtensionOperation() Extension operation to call.
ToolUseExample.ExtensionOperationOrBuilder	getExtensionOperationOrBuilder() Extension operation to call.
String	getFunctionName() Function name to call.
com.google.protobuf.ByteString	getFunctionNameBytes() Function name to call.
com.google.protobuf.Parser<ToolUseExample>	getParserForType()
String	getQuery() Required.
com.google.protobuf.ByteString	getQueryBytes() Required.
com.google.protobuf.Struct	getRequestParams() Request parameters used for executing this tool.
com.google.protobuf.StructOrBuilder	getRequestParamsOrBuilder() Request parameters used for executing this tool.
com.google.protobuf.Struct	getResponseParams() Response parameters generated by this tool.
com.google.protobuf.StructOrBuilder	getResponseParamsOrBuilder() Response parameters generated by this tool.
String	getResponseSummary() Summary of the tool response to the user query.
com.google.protobuf.ByteString	getResponseSummaryBytes() Summary of the tool response to the user query.
int	getSerializedSize()
ToolUseExample.TargetCase	getTargetCase()
boolean	hasExtensionOperation() Extension operation to call.
boolean	hasFunctionName() Function name to call.
int	hashCode()
boolean	hasRequestParams() Request parameters used for executing this tool.
boolean	hasResponseParams() Response parameters generated by this tool.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static ToolUseExample.Builder	newBuilder()
static ToolUseExample.Builder	newBuilder(ToolUseExample prototype)
ToolUseExample.Builder	newBuilderForType()
protected ToolUseExample.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static ToolUseExample	parseDelimitedFrom(InputStream input)
static ToolUseExample	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ToolUseExample	parseFrom(byte[] data)
static ToolUseExample	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ToolUseExample	parseFrom(ByteBuffer data)
static ToolUseExample	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ToolUseExample	parseFrom(com.google.protobuf.ByteString data)
static ToolUseExample	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ToolUseExample	parseFrom(com.google.protobuf.CodedInputStream input)
static ToolUseExample	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static ToolUseExample	parseFrom(InputStream input)
static ToolUseExample	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<ToolUseExample>	parser()
ToolUseExample.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

EXTENSION_OPERATION_FIELD_NUMBER

public static final int EXTENSION_OPERATION_FIELD_NUMBER

See Also:

Constant Field Values

FUNCTION_NAME_FIELD_NUMBER

public static final int FUNCTION_NAME_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

See Also:

Constant Field Values

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER

See Also:

Constant Field Values

REQUEST_PARAMS_FIELD_NUMBER

public static final int REQUEST_PARAMS_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_PARAMS_FIELD_NUMBER

public static final int RESPONSE_PARAMS_FIELD_NUMBER

See Also:

Constant Field Values

RESPONSE_SUMMARY_FIELD_NUMBER

public static final int RESPONSE_SUMMARY_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getTargetCase

public ToolUseExample.TargetCase getTargetCase()

Specified by:

getTargetCase in interface ToolUseExampleOrBuilder

hasExtensionOperation

public boolean hasExtensionOperation()

 Extension operation to call.
 

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Specified by:

hasExtensionOperation in interface ToolUseExampleOrBuilder

Returns:

Whether the extensionOperation field is set.

getExtensionOperation

public ToolUseExample.ExtensionOperation getExtensionOperation()

 Extension operation to call.
 

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Specified by:

getExtensionOperation in interface ToolUseExampleOrBuilder

Returns:

The extensionOperation.

getExtensionOperationOrBuilder

public ToolUseExample.ExtensionOperationOrBuilder getExtensionOperationOrBuilder()

 Extension operation to call.
 

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Specified by:

getExtensionOperationOrBuilder in interface ToolUseExampleOrBuilder

hasFunctionName

public boolean hasFunctionName()

 Function name to call.
 

string function_name = 11;

Specified by:

hasFunctionName in interface ToolUseExampleOrBuilder

Returns:

Whether the functionName field is set.

getFunctionName

public String getFunctionName()

 Function name to call.
 

string function_name = 11;

Specified by:

getFunctionName in interface ToolUseExampleOrBuilder

Returns:

The functionName.

getFunctionNameBytes

public com.google.protobuf.ByteString getFunctionNameBytes()

 Function name to call.
 

string function_name = 11;

Specified by:

getFunctionNameBytes in interface ToolUseExampleOrBuilder

Returns:

The bytes for functionName.

getDisplayName

public String getDisplayName()

 Required. The display name for example.
 

string display_name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayName in interface ToolUseExampleOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 Required. The display name for example.
 

string display_name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getDisplayNameBytes in interface ToolUseExampleOrBuilder

Returns:

The bytes for displayName.

getQuery

public String getQuery()

 Required. Query that should be routed to this tool.
 

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getQuery in interface ToolUseExampleOrBuilder

Returns:

The query.

getQueryBytes

public com.google.protobuf.ByteString getQueryBytes()

 Required. Query that should be routed to this tool.
 

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getQueryBytes in interface ToolUseExampleOrBuilder

Returns:

The bytes for query.

hasRequestParams

public boolean hasRequestParams()

 Request parameters used for executing this tool.
 

.google.protobuf.Struct request_params = 3;

Specified by:

hasRequestParams in interface ToolUseExampleOrBuilder

Returns:

Whether the requestParams field is set.

getRequestParams

public com.google.protobuf.Struct getRequestParams()

 Request parameters used for executing this tool.
 

.google.protobuf.Struct request_params = 3;

Specified by:

getRequestParams in interface ToolUseExampleOrBuilder

Returns:

The requestParams.

getRequestParamsOrBuilder

public com.google.protobuf.StructOrBuilder getRequestParamsOrBuilder()

 Request parameters used for executing this tool.
 

.google.protobuf.Struct request_params = 3;

Specified by:

getRequestParamsOrBuilder in interface ToolUseExampleOrBuilder

hasResponseParams

public boolean hasResponseParams()

 Response parameters generated by this tool.
 

.google.protobuf.Struct response_params = 4;

Specified by:

hasResponseParams in interface ToolUseExampleOrBuilder

Returns:

Whether the responseParams field is set.

getResponseParams

public com.google.protobuf.Struct getResponseParams()

 Response parameters generated by this tool.
 

.google.protobuf.Struct response_params = 4;

Specified by:

getResponseParams in interface ToolUseExampleOrBuilder

Returns:

The responseParams.

getResponseParamsOrBuilder

public com.google.protobuf.StructOrBuilder getResponseParamsOrBuilder()

 Response parameters generated by this tool.
 

.google.protobuf.Struct response_params = 4;

Specified by:

getResponseParamsOrBuilder in interface ToolUseExampleOrBuilder

getResponseSummary

public String getResponseSummary()

 Summary of the tool response to the user query.
 

string response_summary = 5;

Specified by:

getResponseSummary in interface ToolUseExampleOrBuilder

Returns:

The responseSummary.

getResponseSummaryBytes

public com.google.protobuf.ByteString getResponseSummaryBytes()

 Summary of the tool response to the user query.
 

string response_summary = 5;

Specified by:

getResponseSummaryBytes in interface ToolUseExampleOrBuilder

Returns:

The bytes for responseSummary.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static ToolUseExample parseFrom(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ToolUseExample parseFrom(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ToolUseExample parseFrom(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ToolUseExample parseFrom(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ToolUseExample parseFrom(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ToolUseExample parseFrom(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static ToolUseExample parseFrom(InputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static ToolUseExample parseFrom(InputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

parseDelimitedFrom

public static ToolUseExample parseDelimitedFrom(InputStream input)
                                         throws IOException

Throws:

IOException

parseDelimitedFrom

public static ToolUseExample parseDelimitedFrom(InputStream input,
                                                com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                         throws IOException

Throws:

IOException

parseFrom

public static ToolUseExample parseFrom(com.google.protobuf.CodedInputStream input)
                                throws IOException

Throws:

IOException

parseFrom

public static ToolUseExample parseFrom(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException

Throws:

IOException

newBuilderForType

public ToolUseExample.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ToolUseExample.Builder newBuilder()

newBuilder

public static ToolUseExample.Builder newBuilder(ToolUseExample prototype)

toBuilder

public ToolUseExample.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ToolUseExample.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ToolUseExample getDefaultInstance()

parser

public static com.google.protobuf.Parser<ToolUseExample> parser()

getParserForType

public com.google.protobuf.Parser<ToolUseExample> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ToolUseExample getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder