Class ExecuteToolRequest (0.1.0)

public final class ExecuteToolRequest extends GeneratedMessage implements ExecuteToolRequestOrBuilder

Request message for ToolService.ExecuteTool.

Protobuf type google.cloud.ces.v1.ExecuteToolRequest

Static Fields

ARGS_FIELD_NUMBER

public static final int ARGS_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

TOOLSET_TOOL_FIELD_NUMBER

public static final int TOOLSET_TOOL_FIELD_NUMBER
Field Value
Type Description
int

TOOL_FIELD_NUMBER

public static final int TOOL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ExecuteToolRequest getDefaultInstance()
Returns
Type Description
ExecuteToolRequest

getDescriptor()

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

newBuilder()

public static ExecuteToolRequest.Builder newBuilder()
Returns
Type Description
ExecuteToolRequest.Builder

newBuilder(ExecuteToolRequest prototype)

public static ExecuteToolRequest.Builder newBuilder(ExecuteToolRequest prototype)
Parameter
Name Description
prototype ExecuteToolRequest
Returns
Type Description
ExecuteToolRequest.Builder

parseDelimitedFrom(InputStream input)

public static ExecuteToolRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ExecuteToolRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExecuteToolRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExecuteToolRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ExecuteToolRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ExecuteToolRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExecuteToolRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ExecuteToolRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ExecuteToolRequest> parser()
Returns
Type Description
Parser<ExecuteToolRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

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.

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

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.

getParserForType()

public Parser<ExecuteToolRequest> getParserForType()
Returns
Type Description
Parser<ExecuteToolRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected ExecuteToolRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ExecuteToolRequest.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException