Class Tool.ComputerUse.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Tool.ComputerUse.Builder>
com.google.cloud.aiplatform.v1.Tool.ComputerUse.Builder
All Implemented Interfaces:
Tool.ComputerUseOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Tool.ComputerUse

public static final class Tool.ComputerUse.Builder extends com.google.protobuf.GeneratedMessage.Builder<Tool.ComputerUse.Builder> implements Tool.ComputerUseOrBuilder
 Tool to support computer use.
 
Protobuf type google.cloud.aiplatform.v1.Tool.ComputerUse
  • 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.Builder<Tool.ComputerUse.Builder>
    • clear

      public Tool.ComputerUse.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Tool.ComputerUse.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Tool.ComputerUse.Builder>
    • getDefaultInstanceForType

      public Tool.ComputerUse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

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

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

      public Tool.ComputerUse.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tool.ComputerUse.Builder>
    • mergeFrom

      public Tool.ComputerUse.Builder mergeFrom(Tool.ComputerUse other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Tool.ComputerUse.Builder>
    • mergeFrom

      public Tool.ComputerUse.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tool.ComputerUse.Builder>
      Throws:
      IOException
    • 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.
    • setEnvironmentValue

      public Tool.ComputerUse.Builder setEnvironmentValue(int value)
       Required. The environment being operated.
       
      .google.cloud.aiplatform.v1.Tool.ComputerUse.Environment environment = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The enum numeric value on the wire for environment to set.
      Returns:
      This builder for chaining.
    • 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.
    • setEnvironment

       Required. The environment being operated.
       
      .google.cloud.aiplatform.v1.Tool.ComputerUse.Environment environment = 1 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The environment to set.
      Returns:
      This builder for chaining.
    • clearEnvironment

      public Tool.ComputerUse.Builder clearEnvironment()
       Required. The environment being operated.
       
      .google.cloud.aiplatform.v1.Tool.ComputerUse.Environment environment = 1 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.
    • 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.
    • setExcludedPredefinedFunctions

      public Tool.ComputerUse.Builder setExcludedPredefinedFunctions(int index, String value)
       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];
      Parameters:
      index - The index to set the value at.
      value - The excludedPredefinedFunctions to set.
      Returns:
      This builder for chaining.
    • addExcludedPredefinedFunctions

      public Tool.ComputerUse.Builder addExcludedPredefinedFunctions(String value)
       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];
      Parameters:
      value - The excludedPredefinedFunctions to add.
      Returns:
      This builder for chaining.
    • addAllExcludedPredefinedFunctions

      public Tool.ComputerUse.Builder addAllExcludedPredefinedFunctions(Iterable<String> values)
       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];
      Parameters:
      values - The excludedPredefinedFunctions to add.
      Returns:
      This builder for chaining.
    • clearExcludedPredefinedFunctions

      public Tool.ComputerUse.Builder clearExcludedPredefinedFunctions()
       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];
      Returns:
      This builder for chaining.
    • addExcludedPredefinedFunctionsBytes

      public Tool.ComputerUse.Builder addExcludedPredefinedFunctionsBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes of the excludedPredefinedFunctions to add.
      Returns:
      This builder for chaining.