Package com.google.cloud.aiplatform.v1beta1

Class ToolUseExample

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
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
@Generated public final class ToolUseExample extends com.google.protobuf.GeneratedMessage implements ToolUseExampleOrBuilder
 A single example of the tool usage.
Protobuf type google.cloud.aiplatform.v1beta1.ToolUseExample
See Also:

  • Field Details

    • EXTENSION_OPERATION_FIELD_NUMBER

      public static final int EXTENSION_OPERATION_FIELD_NUMBER
      See Also:

    • FUNCTION_NAME_FIELD_NUMBER

      public static final int FUNCTION_NAME_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • QUERY_FIELD_NUMBER

      public static final int QUERY_FIELD_NUMBER
      See Also:

    • REQUEST_PARAMS_FIELD_NUMBER

      public static final int REQUEST_PARAMS_FIELD_NUMBER
      See Also:

    • RESPONSE_PARAMS_FIELD_NUMBER

      public static final int RESPONSE_PARAMS_FIELD_NUMBER
      See Also:

    • RESPONSE_SUMMARY_FIELD_NUMBER

      public static final int RESPONSE_SUMMARY_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public ToolUseExample getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder