Class QueryReasoningEngineRequest.Builder (3.84.0)

public static final class QueryReasoningEngineRequest.Builder extends GeneratedMessage.Builder<QueryReasoningEngineRequest.Builder> implements QueryReasoningEngineRequestOrBuilder

Request message for [ReasoningEngineExecutionService.Query][].

Protobuf type google.cloud.aiplatform.v1.QueryReasoningEngineRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public QueryReasoningEngineRequest build()
Returns
Type Description
QueryReasoningEngineRequest

buildPartial()

public QueryReasoningEngineRequest buildPartial()
Returns
Type Description
QueryReasoningEngineRequest

clear()

public QueryReasoningEngineRequest.Builder clear()
Returns
Type Description
QueryReasoningEngineRequest.Builder
Overrides

clearClassMethod()

public QueryReasoningEngineRequest.Builder clearClassMethod()

Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.

string class_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
QueryReasoningEngineRequest.Builder

This builder for chaining.

clearInput()

public QueryReasoningEngineRequest.Builder clearInput()

Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.

.google.protobuf.Struct input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
QueryReasoningEngineRequest.Builder

clearName()

public QueryReasoningEngineRequest.Builder clearName()

Required. The name of the ReasoningEngine resource to use. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
QueryReasoningEngineRequest.Builder

This builder for chaining.

getClassMethod()

public String getClassMethod()

Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.

string class_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The classMethod.

getClassMethodBytes()

public ByteString getClassMethodBytes()

Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.

string class_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for classMethod.

getDefaultInstanceForType()

public QueryReasoningEngineRequest getDefaultInstanceForType()
Returns
Type Description
QueryReasoningEngineRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInput()

public Struct getInput()

Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.

.google.protobuf.Struct input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Struct

The input.

getInputBuilder()

public Struct.Builder getInputBuilder()

Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.

.google.protobuf.Struct input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getInputOrBuilder()

public StructOrBuilder getInputOrBuilder()

Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.

.google.protobuf.Struct input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
StructOrBuilder

getName()

public String getName()

Required. The name of the ReasoningEngine resource to use. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The name of the ReasoningEngine resource to use. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

hasInput()

public boolean hasInput()

Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.

.google.protobuf.Struct input = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the input field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(QueryReasoningEngineRequest other)

public QueryReasoningEngineRequest.Builder mergeFrom(QueryReasoningEngineRequest other)
Parameter
Name Description
other QueryReasoningEngineRequest
Returns
Type Description
QueryReasoningEngineRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QueryReasoningEngineRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryReasoningEngineRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public QueryReasoningEngineRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
QueryReasoningEngineRequest.Builder
Overrides

mergeInput(Struct value)

public QueryReasoningEngineRequest.Builder mergeInput(Struct value)

Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.

.google.protobuf.Struct input = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
QueryReasoningEngineRequest.Builder

setClassMethod(String value)

public QueryReasoningEngineRequest.Builder setClassMethod(String value)

Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.

string class_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The classMethod to set.

Returns
Type Description
QueryReasoningEngineRequest.Builder

This builder for chaining.

setClassMethodBytes(ByteString value)

public QueryReasoningEngineRequest.Builder setClassMethodBytes(ByteString value)

Optional. Class method to be used for the query. It is optional and defaults to "query" if unspecified.

string class_method = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for classMethod to set.

Returns
Type Description
QueryReasoningEngineRequest.Builder

This builder for chaining.

setInput(Struct value)

public QueryReasoningEngineRequest.Builder setInput(Struct value)

Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.

.google.protobuf.Struct input = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Struct
Returns
Type Description
QueryReasoningEngineRequest.Builder

setInput(Struct.Builder builderForValue)

public QueryReasoningEngineRequest.Builder setInput(Struct.Builder builderForValue)

Optional. Input content provided by users in JSON object format. Examples include text query, function calling parameters, media bytes, etc.

.google.protobuf.Struct input = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
QueryReasoningEngineRequest.Builder

setName(String value)

public QueryReasoningEngineRequest.Builder setName(String value)

Required. The name of the ReasoningEngine resource to use. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
QueryReasoningEngineRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public QueryReasoningEngineRequest.Builder setNameBytes(ByteString value)

Required. The name of the ReasoningEngine resource to use. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
QueryReasoningEngineRequest.Builder

This builder for chaining.