Package org.opensearch.ml.common

Class ToolMetadata

java.lang.Object

org.opensearch.ml.common.ToolMetadata

All Implemented Interfaces:

org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject

public class ToolMetadata
extends Object
implements org.opensearch.core.xcontent.ToXContentObject, org.opensearch.core.common.io.stream.Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ToolMetadata.ToolMetadataBuilder

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TOOL_DESCRIPTION_FIELD
static final String	TOOL_NAME_FIELD
static final String	TOOL_TYPE_FIELD
static final String	TOOL_VERSION_FIELD

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ToolMetadata(String name, String description, String type, String version)
ToolMetadata(org.opensearch.core.common.io.stream.StreamInput input)

Method Summary

Modifier and Type	Method	Description
static ToolMetadata.ToolMetadataBuilder	builder()
static ToolMetadata	fromStream(org.opensearch.core.common.io.stream.StreamInput in)
String	getDescription()
String	getName()
String	getType()
String	getVersion()
static ToolMetadata	parse(org.opensearch.core.xcontent.XContentParser parser)
ToolMetadata.ToolMetadataBuilder	toBuilder()
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput output)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

isFragment

Field Details

TOOL_NAME_FIELD

public static final String TOOL_NAME_FIELD

See Also:

• Constant Field Values

TOOL_DESCRIPTION_FIELD

public static final String TOOL_DESCRIPTION_FIELD

See Also:

• Constant Field Values

TOOL_TYPE_FIELD

public static final String TOOL_TYPE_FIELD

See Also:

• Constant Field Values

TOOL_VERSION_FIELD

public static final String TOOL_VERSION_FIELD

See Also:

• Constant Field Values

Constructor Details

ToolMetadata

public ToolMetadata(String name,
 String description,
 String type,
 String version)

ToolMetadata

public ToolMetadata(org.opensearch.core.common.io.stream.StreamInput input)
             throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput output)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.xcontent.ToXContent

Throws:

IOException

parse

public static ToolMetadata parse(org.opensearch.core.xcontent.XContentParser parser)
                          throws IOException

Throws:

IOException

fromStream

public static ToolMetadata fromStream(org.opensearch.core.common.io.stream.StreamInput in)
                               throws IOException

Throws:

IOException

builder

public static ToolMetadata.ToolMetadataBuilder builder()

toBuilder

public ToolMetadata.ToolMetadataBuilder toBuilder()

getName

public String getName()

getDescription

public String getDescription()

getType

public String getType()

getVersion

public String getVersion()