com.volcengine.model.maas.api

Class Api.Function

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.volcengine.model.maas.api.Api.Function

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Api.FunctionOrBuilder, Serializable

Enclosing class:

Api

public static final class Api.Function
extends com.google.protobuf.GeneratedMessageV3
implements Api.FunctionOrBuilder

Protobuf type api.Function

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Api.Function.Builder Protobuf type api.Function

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	DESCRIPTION_FIELD_NUMBER
static int	EXAMPLES_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	PARAMETERS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Api.Function	getDefaultInstance()
Api.Function	getDefaultInstanceForType()
String	getDescription() A description of the function, used by the model to choose when and how to call the function.
com.google.protobuf.ByteString	getDescriptionBytes() A description of the function, used by the model to choose when and how to call the function.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getExamples(int index) The examples of the function parameters, as the above json schema describes.
com.google.protobuf.ByteString	getExamplesBytes(int index) The examples of the function parameters, as the above json schema describes.
int	getExamplesCount() The examples of the function parameters, as the above json schema describes.
com.google.protobuf.ProtocolStringList	getExamplesList() The examples of the function parameters, as the above json schema describes.
String	getName() The name of the function.
com.google.protobuf.ByteString	getNameBytes() The name of the function.
com.google.protobuf.Struct	getParameters() The parameters of the function, described as Json Schema.
com.google.protobuf.StructOrBuilder	getParametersOrBuilder() The parameters of the function, described as Json Schema.
com.google.protobuf.Parser<Api.Function>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasParameters() The parameters of the function, described as Json Schema.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Api.Function.Builder	newBuilder()
static Api.Function.Builder	newBuilder(Api.Function prototype)
Api.Function.Builder	newBuilderForType()
protected Api.Function.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Api.Function	parseDelimitedFrom(InputStream input)
static Api.Function	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Api.Function	parseFrom(byte[] data)
static Api.Function	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Api.Function	parseFrom(ByteBuffer data)
static Api.Function	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Api.Function	parseFrom(com.google.protobuf.ByteString data)
static Api.Function	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Api.Function	parseFrom(com.google.protobuf.CodedInputStream input)
static Api.Function	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Api.Function	parseFrom(InputStream input)
static Api.Function	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Api.Function>	parser()
Api.Function.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

See Also:

Constant Field Values

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER

See Also:

Constant Field Values

EXAMPLES_FIELD_NUMBER

public static final int EXAMPLES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 The name of the function.
 

string name = 1;

Specified by:

getName in interface Api.FunctionOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The name of the function.
 

string name = 1;

Specified by:

getNameBytes in interface Api.FunctionOrBuilder

Returns:

The bytes for name.

getDescription

public String getDescription()

 A description of the function, used by the model to choose when and how to
 call the function.
 

string description = 2;

Specified by:

getDescription in interface Api.FunctionOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 A description of the function, used by the model to choose when and how to
 call the function.
 

string description = 2;

Specified by:

getDescriptionBytes in interface Api.FunctionOrBuilder

Returns:

The bytes for description.

hasParameters

public boolean hasParameters()

 The parameters of the function, described as Json Schema.
 

.google.protobuf.Struct parameters = 3;

Specified by:

hasParameters in interface Api.FunctionOrBuilder

Returns:

Whether the parameters field is set.

getParameters

public com.google.protobuf.Struct getParameters()

 The parameters of the function, described as Json Schema.
 

.google.protobuf.Struct parameters = 3;

Specified by:

getParameters in interface Api.FunctionOrBuilder

Returns:

The parameters.

getParametersOrBuilder

public com.google.protobuf.StructOrBuilder getParametersOrBuilder()

 The parameters of the function, described as Json Schema.
 

.google.protobuf.Struct parameters = 3;

Specified by:

getParametersOrBuilder in interface Api.FunctionOrBuilder

getExamplesList

public com.google.protobuf.ProtocolStringList getExamplesList()

 The examples of the function parameters, as the above json schema
 describes.
 

repeated string examples = 4;

Specified by:

getExamplesList in interface Api.FunctionOrBuilder

Returns:

A list containing the examples.

getExamplesCount

public int getExamplesCount()

 The examples of the function parameters, as the above json schema
 describes.
 

repeated string examples = 4;

Specified by:

getExamplesCount in interface Api.FunctionOrBuilder

Returns:

The count of examples.

getExamples

public String getExamples(int index)

 The examples of the function parameters, as the above json schema
 describes.
 

repeated string examples = 4;

Specified by:

getExamples in interface Api.FunctionOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The examples at the given index.

getExamplesBytes

public com.google.protobuf.ByteString getExamplesBytes(int index)

 The examples of the function parameters, as the above json schema
 describes.
 

repeated string examples = 4;

Specified by:

getExamplesBytes in interface Api.FunctionOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the examples at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Api.Function parseFrom(ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api.Function parseFrom(ByteBuffer data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api.Function parseFrom(com.google.protobuf.ByteString data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api.Function parseFrom(com.google.protobuf.ByteString data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api.Function parseFrom(byte[] data)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api.Function parseFrom(byte[] data,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Api.Function parseFrom(InputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static Api.Function parseFrom(InputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

parseDelimitedFrom

public static Api.Function parseDelimitedFrom(InputStream input)
                                       throws IOException

Throws:

IOException

parseDelimitedFrom

public static Api.Function parseDelimitedFrom(InputStream input,
                                              com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                       throws IOException

Throws:

IOException

parseFrom

public static Api.Function parseFrom(com.google.protobuf.CodedInputStream input)
                              throws IOException

Throws:

IOException

parseFrom

public static Api.Function parseFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Throws:

IOException

newBuilderForType

public Api.Function.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Api.Function.Builder newBuilder()

newBuilder

public static Api.Function.Builder newBuilder(Api.Function prototype)

toBuilder

public Api.Function.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Api.Function.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Api.Function getDefaultInstance()

parser

public static com.google.protobuf.Parser<Api.Function> parser()

getParserForType

public com.google.protobuf.Parser<Api.Function> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Api.Function getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder