com.google.cloud.aiplatform.v1beta1

Class FunctionDeclaration

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1beta1.FunctionDeclaration

All Implemented Interfaces:

FunctionDeclarationOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class FunctionDeclaration
extends com.google.protobuf.GeneratedMessageV3
implements FunctionDeclarationOrBuilder

 Structured representation of a function declaration as defined by the
 [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included
 in this declaration are the function name, description, parameters and
 response type. This FunctionDeclaration is a representation of a block of
 code that can be used as a `Tool` by the model and executed by the client.
 

Protobuf type google.cloud.aiplatform.v1beta1.FunctionDeclaration

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FunctionDeclaration.Builder Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3).

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	NAME_FIELD_NUMBER
static int	PARAMETERS_FIELD_NUMBER
static int	RESPONSE_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 FunctionDeclaration	getDefaultInstance()
FunctionDeclaration	getDefaultInstanceForType()
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
Schema	getParameters() Optional.
SchemaOrBuilder	getParametersOrBuilder() Optional.
com.google.protobuf.Parser<FunctionDeclaration>	getParserForType()
Schema	getResponse() Optional.
SchemaOrBuilder	getResponseOrBuilder() Optional.
int	getSerializedSize()
int	hashCode()
boolean	hasParameters() Optional.
boolean	hasResponse() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static FunctionDeclaration.Builder	newBuilder()
static FunctionDeclaration.Builder	newBuilder(FunctionDeclaration prototype)
FunctionDeclaration.Builder	newBuilderForType()
protected FunctionDeclaration.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static FunctionDeclaration	parseDelimitedFrom(InputStream input)
static FunctionDeclaration	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FunctionDeclaration	parseFrom(byte[] data)
static FunctionDeclaration	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FunctionDeclaration	parseFrom(ByteBuffer data)
static FunctionDeclaration	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FunctionDeclaration	parseFrom(com.google.protobuf.ByteString data)
static FunctionDeclaration	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FunctionDeclaration	parseFrom(com.google.protobuf.CodedInputStream input)
static FunctionDeclaration	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static FunctionDeclaration	parseFrom(InputStream input)
static FunctionDeclaration	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<FunctionDeclaration>	parser()
FunctionDeclaration.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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, getUnknownFields, 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

RESPONSE_FIELD_NUMBER

public static final int RESPONSE_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

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()

 Required. The name of the function to call.
 Must start with a letter or an underscore.
 Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a
 maximum length of 64.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getName in interface FunctionDeclarationOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 Required. The name of the function to call.
 Must start with a letter or an underscore.
 Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a
 maximum length of 64.
 

string name = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getNameBytes in interface FunctionDeclarationOrBuilder

Returns:

The bytes for name.

getDescription

public String getDescription()

 Optional. Description and purpose of the function.
 Model uses it to decide how and whether to call the function.
 

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDescription in interface FunctionDeclarationOrBuilder

Returns:

The description.

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 Optional. Description and purpose of the function.
 Model uses it to decide how and whether to call the function.
 

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDescriptionBytes in interface FunctionDeclarationOrBuilder

Returns:

The bytes for description.

hasParameters

public boolean hasParameters()

 Optional. Describes the parameters to this function in JSON Schema Object
 format. Reflects the Open API 3.03 Parameter Object. string Key: the name
 of the parameter. Parameter names are case sensitive. Schema Value: the
 Schema defining the type used for the parameter. For function with no
 parameters, this can be left unset. Parameter names must start with a
 letter or an underscore and must only contain chars a-z, A-Z, 0-9, or
 underscores with a maximum length of 64. Example with 1 required and 1
 optional parameter: type: OBJECT properties:
  param1:
    type: STRING
  param2:
    type: INTEGER
 required:
  - param1
 

.google.cloud.aiplatform.v1beta1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasParameters in interface FunctionDeclarationOrBuilder

Returns:

Whether the parameters field is set.

getParameters

public Schema getParameters()

 Optional. Describes the parameters to this function in JSON Schema Object
 format. Reflects the Open API 3.03 Parameter Object. string Key: the name
 of the parameter. Parameter names are case sensitive. Schema Value: the
 Schema defining the type used for the parameter. For function with no
 parameters, this can be left unset. Parameter names must start with a
 letter or an underscore and must only contain chars a-z, A-Z, 0-9, or
 underscores with a maximum length of 64. Example with 1 required and 1
 optional parameter: type: OBJECT properties:
  param1:
    type: STRING
  param2:
    type: INTEGER
 required:
  - param1
 

.google.cloud.aiplatform.v1beta1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getParameters in interface FunctionDeclarationOrBuilder

Returns:

The parameters.

getParametersOrBuilder

public SchemaOrBuilder getParametersOrBuilder()

 Optional. Describes the parameters to this function in JSON Schema Object
 format. Reflects the Open API 3.03 Parameter Object. string Key: the name
 of the parameter. Parameter names are case sensitive. Schema Value: the
 Schema defining the type used for the parameter. For function with no
 parameters, this can be left unset. Parameter names must start with a
 letter or an underscore and must only contain chars a-z, A-Z, 0-9, or
 underscores with a maximum length of 64. Example with 1 required and 1
 optional parameter: type: OBJECT properties:
  param1:
    type: STRING
  param2:
    type: INTEGER
 required:
  - param1
 

.google.cloud.aiplatform.v1beta1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getParametersOrBuilder in interface FunctionDeclarationOrBuilder

hasResponse

public boolean hasResponse()

 Optional. Describes the output from this function in JSON Schema format.
 Reflects the Open API 3.03 Response Object. The Schema defines the type
 used for the response value of the function.
 

.google.cloud.aiplatform.v1beta1.Schema response = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasResponse in interface FunctionDeclarationOrBuilder

Returns:

Whether the response field is set.

getResponse

public Schema getResponse()

 Optional. Describes the output from this function in JSON Schema format.
 Reflects the Open API 3.03 Response Object. The Schema defines the type
 used for the response value of the function.
 

.google.cloud.aiplatform.v1beta1.Schema response = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponse in interface FunctionDeclarationOrBuilder

Returns:

The response.

getResponseOrBuilder

public SchemaOrBuilder getResponseOrBuilder()

 Optional. Describes the output from this function in JSON Schema format.
 Reflects the Open API 3.03 Response Object. The Schema defines the type
 used for the response value of the function.
 

.google.cloud.aiplatform.v1beta1.Schema response = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getResponseOrBuilder in interface FunctionDeclarationOrBuilder

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 FunctionDeclaration parseFrom(ByteBuffer data)
                                     throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static FunctionDeclaration parseFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static FunctionDeclaration parseDelimitedFrom(InputStream input)
                                              throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public FunctionDeclaration.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static FunctionDeclaration.Builder newBuilder()

newBuilder

public static FunctionDeclaration.Builder newBuilder(FunctionDeclaration prototype)

toBuilder

public FunctionDeclaration.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static FunctionDeclaration getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<FunctionDeclaration> 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 FunctionDeclaration getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder