Package com.google.cloud.aiplatform.v1

Class Tool.ComputerUse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Tool.ComputerUse
All Implemented Interfaces:
Tool.ComputerUseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Tool
public static final class Tool.ComputerUse extends com.google.protobuf.GeneratedMessage implements Tool.ComputerUseOrBuilder
 Tool to support computer use.
Protobuf type google.cloud.aiplatform.v1.Tool.ComputerUse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Tool.ComputerUse.Builder
    Tool to support computer use.
    static enum 
    Tool.ComputerUse.Environment
    Represents the environment being operated, such as a web browser.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ENVIRONMENT_FIELD_NUMBER
     
    static final int
    EXCLUDED_PREDEFINED_FUNCTIONS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    static Tool.ComputerUse
    getDefaultInstance()
     
    Tool.ComputerUse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Tool.ComputerUse.Environment
    getEnvironment()
    Required.
    int
    getEnvironmentValue()
    Required.
    String
    getExcludedPredefinedFunctions(int index)
    Optional.
    com.google.protobuf.ByteString
    getExcludedPredefinedFunctionsBytes(int index)
    Optional.
    int
    getExcludedPredefinedFunctionsCount()
    Optional.
    com.google.protobuf.ProtocolStringList
    getExcludedPredefinedFunctionsList()
    Optional.
    com.google.protobuf.Parser<Tool.ComputerUse>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Tool.ComputerUse.Builder
    newBuilder()
     
    static Tool.ComputerUse.Builder
    newBuilder(Tool.ComputerUse prototype)
     
    Tool.ComputerUse.Builder
    newBuilderForType()
     
    protected Tool.ComputerUse.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Tool.ComputerUse
    parseDelimitedFrom(InputStream input)
     
    static Tool.ComputerUse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Tool.ComputerUse
    parseFrom(byte[] data)
     
    static Tool.ComputerUse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Tool.ComputerUse
    parseFrom(com.google.protobuf.ByteString data)
     
    static Tool.ComputerUse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Tool.ComputerUse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Tool.ComputerUse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Tool.ComputerUse
    parseFrom(InputStream input)
     
    static Tool.ComputerUse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Tool.ComputerUse
    parseFrom(ByteBuffer data)
     
    static Tool.ComputerUse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Tool.ComputerUse>
    parser()
     
    Tool.ComputerUse.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • ENVIRONMENT_FIELD_NUMBER

      public static final int ENVIRONMENT_FIELD_NUMBER
      See Also:

    • EXCLUDED_PREDEFINED_FUNCTIONS_FIELD_NUMBER

      public static final int EXCLUDED_PREDEFINED_FUNCTIONS_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

    • getEnvironmentValue

      public int getEnvironmentValue()
       Required. The environment being operated.
      .google.cloud.aiplatform.v1.Tool.ComputerUse.Environment environment = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEnvironmentValue in interface Tool.ComputerUseOrBuilder
      Returns:
      The enum numeric value on the wire for environment.

    • getEnvironment

      public Tool.ComputerUse.Environment getEnvironment()
       Required. The environment being operated.
      .google.cloud.aiplatform.v1.Tool.ComputerUse.Environment environment = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getEnvironment in interface Tool.ComputerUseOrBuilder
      Returns:
      The environment.

    • getExcludedPredefinedFunctionsList

      public com.google.protobuf.ProtocolStringList getExcludedPredefinedFunctionsList()
       Optional. By default, [predefined
 functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions)
 are included in the final model call. Some of them can be explicitly
 excluded from being automatically included. This can serve two purposes:
 1. Using a more restricted / different action space.
 2. Improving the definitions / instructions of predefined functions.
      repeated string excluded_predefined_functions = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExcludedPredefinedFunctionsList in interface Tool.ComputerUseOrBuilder
      Returns:
      A list containing the excludedPredefinedFunctions.

    • getExcludedPredefinedFunctionsCount

      public int getExcludedPredefinedFunctionsCount()
       Optional. By default, [predefined
 functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions)
 are included in the final model call. Some of them can be explicitly
 excluded from being automatically included. This can serve two purposes:
 1. Using a more restricted / different action space.
 2. Improving the definitions / instructions of predefined functions.
      repeated string excluded_predefined_functions = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExcludedPredefinedFunctionsCount in interface Tool.ComputerUseOrBuilder
      Returns:
      The count of excludedPredefinedFunctions.

    • getExcludedPredefinedFunctions

      public String getExcludedPredefinedFunctions(int index)
       Optional. By default, [predefined
 functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions)
 are included in the final model call. Some of them can be explicitly
 excluded from being automatically included. This can serve two purposes:
 1. Using a more restricted / different action space.
 2. Improving the definitions / instructions of predefined functions.
      repeated string excluded_predefined_functions = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExcludedPredefinedFunctions in interface Tool.ComputerUseOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The excludedPredefinedFunctions at the given index.

    • getExcludedPredefinedFunctionsBytes

      public com.google.protobuf.ByteString getExcludedPredefinedFunctionsBytes(int index)
       Optional. By default, [predefined
 functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions)
 are included in the final model call. Some of them can be explicitly
 excluded from being automatically included. This can serve two purposes:
 1. Using a more restricted / different action space.
 2. Improving the definitions / instructions of predefined functions.
      repeated string excluded_predefined_functions = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExcludedPredefinedFunctionsBytes in interface Tool.ComputerUseOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the excludedPredefinedFunctions at the given index.

    • 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 Tool.ComputerUse parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ComputerUse parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ComputerUse parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ComputerUse parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ComputerUse parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ComputerUse parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Tool.ComputerUse parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool.ComputerUse parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Tool.ComputerUse parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Tool.ComputerUse parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool.ComputerUse parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Tool.ComputerUse parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Tool.ComputerUse.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Tool.ComputerUse.Builder newBuilder()

    • newBuilder

      public static Tool.ComputerUse.Builder newBuilder(Tool.ComputerUse prototype)

    • toBuilder

      public Tool.ComputerUse.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Tool.ComputerUse.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Tool.ComputerUse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Tool.ComputerUse> 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 Tool.ComputerUse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder