Class ToolUseExample.Builder (3.40.0)

public static final class ToolUseExample.Builder extends GeneratedMessageV3.Builder<ToolUseExample.Builder> implements ToolUseExampleOrBuilder

A single example of the tool usage.

Protobuf type google.cloud.aiplatform.v1beta1.ToolUseExample

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ToolUseExample.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ToolUseExample.Builder
Overrides

build()

public ToolUseExample build()
Returns
TypeDescription
ToolUseExample

buildPartial()

public ToolUseExample buildPartial()
Returns
TypeDescription
ToolUseExample

clear()

public ToolUseExample.Builder clear()
Returns
TypeDescription
ToolUseExample.Builder
Overrides

clearDisplayName()

public ToolUseExample.Builder clearDisplayName()

Required. The display name for example.

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

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

clearExtensionOperation()

public ToolUseExample.Builder clearExtensionOperation()

Extension operation to call.

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

Returns
TypeDescription
ToolUseExample.Builder

clearField(Descriptors.FieldDescriptor field)

public ToolUseExample.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ToolUseExample.Builder
Overrides

clearFunctionName()

public ToolUseExample.Builder clearFunctionName()

Function name to call.

string function_name = 11;

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ToolUseExample.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ToolUseExample.Builder
Overrides

clearQuery()

public ToolUseExample.Builder clearQuery()

Required. Query that should be routed to this tool.

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

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

clearRequestParams()

public ToolUseExample.Builder clearRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
TypeDescription
ToolUseExample.Builder

clearResponseParams()

public ToolUseExample.Builder clearResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
ToolUseExample.Builder

clearResponseSummary()

public ToolUseExample.Builder clearResponseSummary()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

clearTarget()

public ToolUseExample.Builder clearTarget()
Returns
TypeDescription
ToolUseExample.Builder

clone()

public ToolUseExample.Builder clone()
Returns
TypeDescription
ToolUseExample.Builder
Overrides

getDefaultInstanceForType()

public ToolUseExample getDefaultInstanceForType()
Returns
TypeDescription
ToolUseExample

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Required. The display name for example.

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

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name for example.

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

Returns
TypeDescription
ByteString

The bytes for displayName.

getExtensionOperation()

public ToolUseExample.ExtensionOperation getExtensionOperation()

Extension operation to call.

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

Returns
TypeDescription
ToolUseExample.ExtensionOperation

The extensionOperation.

getExtensionOperationBuilder()

public ToolUseExample.ExtensionOperation.Builder getExtensionOperationBuilder()

Extension operation to call.

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

Returns
TypeDescription
ToolUseExample.ExtensionOperation.Builder

getExtensionOperationOrBuilder()

public ToolUseExample.ExtensionOperationOrBuilder getExtensionOperationOrBuilder()

Extension operation to call.

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

Returns
TypeDescription
ToolUseExample.ExtensionOperationOrBuilder

getFunctionName()

public String getFunctionName()

Function name to call.

string function_name = 11;

Returns
TypeDescription
String

The functionName.

getFunctionNameBytes()

public ByteString getFunctionNameBytes()

Function name to call.

string function_name = 11;

Returns
TypeDescription
ByteString

The bytes for functionName.

getQuery()

public String getQuery()

Required. Query that should be routed to this tool.

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

Returns
TypeDescription
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

Required. Query that should be routed to this tool.

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

Returns
TypeDescription
ByteString

The bytes for query.

getRequestParams()

public Struct getRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
TypeDescription
Struct

The requestParams.

getRequestParamsBuilder()

public Struct.Builder getRequestParamsBuilder()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
TypeDescription
Builder

getRequestParamsOrBuilder()

public StructOrBuilder getRequestParamsOrBuilder()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
TypeDescription
StructOrBuilder

getResponseParams()

public Struct getResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
Struct

The responseParams.

getResponseParamsBuilder()

public Struct.Builder getResponseParamsBuilder()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
Builder

getResponseParamsOrBuilder()

public StructOrBuilder getResponseParamsOrBuilder()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
StructOrBuilder

getResponseSummary()

public String getResponseSummary()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
TypeDescription
String

The responseSummary.

getResponseSummaryBytes()

public ByteString getResponseSummaryBytes()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
TypeDescription
ByteString

The bytes for responseSummary.

getTargetCase()

public ToolUseExample.TargetCase getTargetCase()
Returns
TypeDescription
ToolUseExample.TargetCase

hasExtensionOperation()

public boolean hasExtensionOperation()

Extension operation to call.

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

Returns
TypeDescription
boolean

Whether the extensionOperation field is set.

hasFunctionName()

public boolean hasFunctionName()

Function name to call.

string function_name = 11;

Returns
TypeDescription
boolean

Whether the functionName field is set.

hasRequestParams()

public boolean hasRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
TypeDescription
boolean

Whether the requestParams field is set.

hasResponseParams()

public boolean hasResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
boolean

Whether the responseParams field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeExtensionOperation(ToolUseExample.ExtensionOperation value)

public ToolUseExample.Builder mergeExtensionOperation(ToolUseExample.ExtensionOperation value)

Extension operation to call.

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

Parameter
NameDescription
valueToolUseExample.ExtensionOperation
Returns
TypeDescription
ToolUseExample.Builder

mergeFrom(ToolUseExample other)

public ToolUseExample.Builder mergeFrom(ToolUseExample other)
Parameter
NameDescription
otherToolUseExample
Returns
TypeDescription
ToolUseExample.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ToolUseExample.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolUseExample.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ToolUseExample.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ToolUseExample.Builder
Overrides

mergeRequestParams(Struct value)

public ToolUseExample.Builder mergeRequestParams(Struct value)

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
ToolUseExample.Builder

mergeResponseParams(Struct value)

public ToolUseExample.Builder mergeResponseParams(Struct value)

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
ToolUseExample.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ToolUseExample.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ToolUseExample.Builder
Overrides

setDisplayName(String value)

public ToolUseExample.Builder setDisplayName(String value)

Required. The display name for example.

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

Parameter
NameDescription
valueString

The displayName to set.

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public ToolUseExample.Builder setDisplayNameBytes(ByteString value)

Required. The display name for example.

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

Parameter
NameDescription
valueByteString

The bytes for displayName to set.

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

setExtensionOperation(ToolUseExample.ExtensionOperation value)

public ToolUseExample.Builder setExtensionOperation(ToolUseExample.ExtensionOperation value)

Extension operation to call.

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

Parameter
NameDescription
valueToolUseExample.ExtensionOperation
Returns
TypeDescription
ToolUseExample.Builder

setExtensionOperation(ToolUseExample.ExtensionOperation.Builder builderForValue)

public ToolUseExample.Builder setExtensionOperation(ToolUseExample.ExtensionOperation.Builder builderForValue)

Extension operation to call.

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

Parameter
NameDescription
builderForValueToolUseExample.ExtensionOperation.Builder
Returns
TypeDescription
ToolUseExample.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ToolUseExample.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ToolUseExample.Builder
Overrides

setFunctionName(String value)

public ToolUseExample.Builder setFunctionName(String value)

Function name to call.

string function_name = 11;

Parameter
NameDescription
valueString

The functionName to set.

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

setFunctionNameBytes(ByteString value)

public ToolUseExample.Builder setFunctionNameBytes(ByteString value)

Function name to call.

string function_name = 11;

Parameter
NameDescription
valueByteString

The bytes for functionName to set.

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

setQuery(String value)

public ToolUseExample.Builder setQuery(String value)

Required. Query that should be routed to this tool.

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

Parameter
NameDescription
valueString

The query to set.

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

setQueryBytes(ByteString value)

public ToolUseExample.Builder setQueryBytes(ByteString value)

Required. Query that should be routed to this tool.

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

Parameter
NameDescription
valueByteString

The bytes for query to set.

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ToolUseExample.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ToolUseExample.Builder
Overrides

setRequestParams(Struct value)

public ToolUseExample.Builder setRequestParams(Struct value)

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
ToolUseExample.Builder

setRequestParams(Struct.Builder builderForValue)

public ToolUseExample.Builder setRequestParams(Struct.Builder builderForValue)

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ToolUseExample.Builder

setResponseParams(Struct value)

public ToolUseExample.Builder setResponseParams(Struct value)

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
ToolUseExample.Builder

setResponseParams(Struct.Builder builderForValue)

public ToolUseExample.Builder setResponseParams(Struct.Builder builderForValue)

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
ToolUseExample.Builder

setResponseSummary(String value)

public ToolUseExample.Builder setResponseSummary(String value)

Summary of the tool response to the user query.

string response_summary = 5;

Parameter
NameDescription
valueString

The responseSummary to set.

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

setResponseSummaryBytes(ByteString value)

public ToolUseExample.Builder setResponseSummaryBytes(ByteString value)

Summary of the tool response to the user query.

string response_summary = 5;

Parameter
NameDescription
valueByteString

The bytes for responseSummary to set.

Returns
TypeDescription
ToolUseExample.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ToolUseExample.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ToolUseExample.Builder
Overrides