Class ExecuteToolRequest.Builder (0.1.0)

public static final class ExecuteToolRequest.Builder extends GeneratedMessage.Builder<ExecuteToolRequest.Builder> implements ExecuteToolRequestOrBuilder

Request message for ToolService.ExecuteTool.

Protobuf type google.cloud.ces.v1.ExecuteToolRequest

Static Methods

getDescriptor()

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

Methods

build()

public ExecuteToolRequest build()
Returns
Type Description
ExecuteToolRequest

buildPartial()

public ExecuteToolRequest buildPartial()
Returns
Type Description
ExecuteToolRequest

clear()

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

clearArgs()

public ExecuteToolRequest.Builder clearArgs()

Optional. The input parameters and values for the tool in JSON object format.

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

Returns
Type Description
ExecuteToolRequest.Builder

clearParent()

public ExecuteToolRequest.Builder clearParent()

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ExecuteToolRequest.Builder

This builder for chaining.

clearTool()

public ExecuteToolRequest.Builder clearTool()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ExecuteToolRequest.Builder

This builder for chaining.

clearToolIdentifier()

public ExecuteToolRequest.Builder clearToolIdentifier()
Returns
Type Description
ExecuteToolRequest.Builder

clearToolsetTool()

public ExecuteToolRequest.Builder clearToolsetTool()

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ExecuteToolRequest.Builder

getArgs()

public Struct getArgs()

Optional. The input parameters and values for the tool in JSON object format.

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

Returns
Type Description
Struct

The args.

getArgsBuilder()

public Struct.Builder getArgsBuilder()

Optional. The input parameters and values for the tool in JSON object format.

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

Returns
Type Description
Builder

getArgsOrBuilder()

public StructOrBuilder getArgsOrBuilder()

Optional. The input parameters and values for the tool in JSON object format.

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

Returns
Type Description
StructOrBuilder

getDefaultInstanceForType()

public ExecuteToolRequest getDefaultInstanceForType()
Returns
Type Description
ExecuteToolRequest

getDescriptorForType()

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

getParent()

public String getParent()

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getTool()

public String getTool()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The tool.

getToolBytes()

public ByteString getToolBytes()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for tool.

getToolIdentifierCase()

public ExecuteToolRequest.ToolIdentifierCase getToolIdentifierCase()
Returns
Type Description
ExecuteToolRequest.ToolIdentifierCase

getToolsetTool()

public ToolsetTool getToolsetTool()

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolsetTool

The toolsetTool.

getToolsetToolBuilder()

public ToolsetTool.Builder getToolsetToolBuilder()

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolsetTool.Builder

getToolsetToolOrBuilder()

public ToolsetToolOrBuilder getToolsetToolOrBuilder()

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ToolsetToolOrBuilder

hasArgs()

public boolean hasArgs()

Optional. The input parameters and values for the tool in JSON object format.

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

Returns
Type Description
boolean

Whether the args field is set.

hasTool()

public boolean hasTool()

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the tool field is set.

hasToolsetTool()

public boolean hasToolsetTool()

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the toolsetTool field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeArgs(Struct value)

public ExecuteToolRequest.Builder mergeArgs(Struct value)

Optional. The input parameters and values for the tool in JSON object format.

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

Parameter
Name Description
value Struct
Returns
Type Description
ExecuteToolRequest.Builder

mergeFrom(ExecuteToolRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeToolsetTool(ToolsetTool value)

public ExecuteToolRequest.Builder mergeToolsetTool(ToolsetTool value)

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolsetTool
Returns
Type Description
ExecuteToolRequest.Builder

setArgs(Struct value)

public ExecuteToolRequest.Builder setArgs(Struct value)

Optional. The input parameters and values for the tool in JSON object format.

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

Parameter
Name Description
value Struct
Returns
Type Description
ExecuteToolRequest.Builder

setArgs(Struct.Builder builderForValue)

public ExecuteToolRequest.Builder setArgs(Struct.Builder builderForValue)

Optional. The input parameters and values for the tool in JSON object format.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ExecuteToolRequest.Builder

setParent(String value)

public ExecuteToolRequest.Builder setParent(String value)

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ExecuteToolRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ExecuteToolRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the app which the tool/toolset belongs to. Format: projects/{project}/locations/{location}/apps/{app}

string parent = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ExecuteToolRequest.Builder

This builder for chaining.

setTool(String value)

public ExecuteToolRequest.Builder setTool(String value)

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The tool to set.

Returns
Type Description
ExecuteToolRequest.Builder

This builder for chaining.

setToolBytes(ByteString value)

public ExecuteToolRequest.Builder setToolBytes(ByteString value)

Optional. The name of the tool to execute. Format: projects/{project}/locations/{location}/apps/{app}/tools/{tool}

string tool = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for tool to set.

Returns
Type Description
ExecuteToolRequest.Builder

This builder for chaining.

setToolsetTool(ToolsetTool value)

public ExecuteToolRequest.Builder setToolsetTool(ToolsetTool value)

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ToolsetTool
Returns
Type Description
ExecuteToolRequest.Builder

setToolsetTool(ToolsetTool.Builder builderForValue)

public ExecuteToolRequest.Builder setToolsetTool(ToolsetTool.Builder builderForValue)

Optional. The toolset tool to execute. Only one tool should match the predicate from the toolset. Otherwise, an error will be returned.

.google.cloud.ces.v1.ToolsetTool toolset_tool = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue ToolsetTool.Builder
Returns
Type Description
ExecuteToolRequest.Builder