Dichiarazione di funzione di classe (1.3.0)

public final class FunctionDeclaration extends GeneratedMessageV3 implements FunctionDeclarationOrBuilder

Rappresentazione strutturata della dichiarazione di una funzione come definita dalla specifica OpenAPI 3.0. Questa dichiarazione include il nome e i parametri della funzione. Questa FunctionDeclaration è una rappresentazione di un blocco di codice che può essere utilizzato come Tool dal modello ed eseguito dal client.

Tipo di protobuf google.cloud.vertexai.v1.FunctionDeclaration

Campi statici

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Valore campo
Tipo Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Valore campo
Tipo Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Valore campo
Tipo Description
int

Metodi statici

getDefaultInstance()

public static FunctionDeclaration getDefaultInstance()
Restituisce
Tipo Description
FunctionDeclaration

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Restituisce
Tipo Description
Descriptor

newBuilder()

public static FunctionDeclaration.Builder newBuilder()
Restituisce
Tipo Description
FunctionDeclaration.Builder

newBuilder(FunctionDeclaration prototype)

public static FunctionDeclaration.Builder newBuilder(FunctionDeclaration prototype)
Parametro
Nome Description
prototype FunctionDeclaration
Restituisce
Tipo Description
FunctionDeclaration.Builder

parseDelimitedFrom(InputStream input)

public static FunctionDeclaration parseDelimitedFrom(InputStream input)
Parametro
Nome Description
input InputStream
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionDeclaration parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parametri
Nome Description
input InputStream
extensionRegistry ExtensionRegistryLite
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
IOException

parseFrom(byte[] data)

public static FunctionDeclaration parseFrom(byte[] data)
Parametro
Nome Description
data byte[]
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FunctionDeclaration parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parametri
Nome Description
data byte[]
extensionRegistry ExtensionRegistryLite
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FunctionDeclaration parseFrom(ByteString data)
Parametro
Nome Description
data ByteString
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FunctionDeclaration parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parametri
Nome Description
data ByteString
extensionRegistry ExtensionRegistryLite
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FunctionDeclaration parseFrom(CodedInputStream input)
Parametro
Nome Description
input CodedInputStream
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionDeclaration parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parametri
Nome Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
IOException

parseFrom(InputStream input)

public static FunctionDeclaration parseFrom(InputStream input)
Parametro
Nome Description
input InputStream
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionDeclaration parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parametri
Nome Description
input InputStream
extensionRegistry ExtensionRegistryLite
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
IOException

parseFrom(ByteBuffer data)

public static FunctionDeclaration parseFrom(ByteBuffer data)
Parametro
Nome Description
data ByteBuffer
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FunctionDeclaration parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parametri
Nome Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Restituisce
Tipo Description
FunctionDeclaration
Eccezioni
Tipo Description
InvalidProtocolBufferException

parser()

public static Parser<FunctionDeclaration> parser()
Restituisce
Tipo Description
Parser<FunctionDeclaration>

Metodi

è uguale a(obj oggetto)

public boolean equals(Object obj)
Parametro
Nome Description
obj Object
Restituisce
Tipo Description
boolean
Sostituzioni

getDefaultInstanceForType()

public FunctionDeclaration getDefaultInstanceForType()
Restituisce
Tipo Description
FunctionDeclaration

getDescription()

public String getDescription()

Facoltativo. Descrizione e scopo della funzione. Il modello la utilizza per decidere come e se chiamare la funzione.

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

Restituisce
Tipo Description
String

La descrizione.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Facoltativo. Descrizione e scopo della funzione. Il modello la utilizza per decidere come e se chiamare la funzione.

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

Restituisce
Tipo Description
ByteString

I byte per la descrizione.

getName()

public String getName()

Obbligatorio. Il nome della funzione da chiamare. Deve iniziare con una lettera o un trattino basso. Deve essere a-z, A-Z, 0-9 o contenere trattini bassi, punti e trattini, con una lunghezza massima di 64.

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

Restituisce
Tipo Description
String

Il nome.

getNameBytes()

public ByteString getNameBytes()

Obbligatorio. Il nome della funzione da chiamare. Deve iniziare con una lettera o un trattino basso. Deve essere a-z, A-Z, 0-9 o contenere trattini bassi, punti e trattini, con una lunghezza massima di 64.

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

Restituisce
Tipo Description
ByteString

I byte per il nome.

getParameters()

public Schema getParameters()

Facoltativo. Descrive i parametri di questa funzione nel formato JSON Schema Object. Riflette l'oggetto parametro Open API 3.03. string Chiave: il nome del parametro. I nomi dei parametri sono sensibili alle maiuscole. Valore schema: lo schema che definisce il tipo utilizzato per il parametro. Per una funzione senza parametri, è possibile lasciarla non impostata. I nomi dei parametri devono iniziare con una lettera o un trattino basso e devono contenere solo caratteri a-z, A-Z, 0-9 o trattini bassi con una lunghezza massima di 64. Esempio con 1 parametro obbligatorio e 1 facoltativo: tipo: proprietà OBJECT: param1: tipo: STRING param2: tipo: INTEGER obbligatorio:

  • param1

.google.cloud.vertexai.v1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Restituisce
Tipo Description
Schema

I parametri.

getParametersOrBuilder()

public SchemaOrBuilder getParametersOrBuilder()

Facoltativo. Descrive i parametri di questa funzione nel formato JSON Schema Object. Riflette l'oggetto parametro Open API 3.03. string Chiave: il nome del parametro. I nomi dei parametri sono sensibili alle maiuscole. Valore schema: lo schema che definisce il tipo utilizzato per il parametro. Per una funzione senza parametri, è possibile lasciarla non impostata. I nomi dei parametri devono iniziare con una lettera o un trattino basso e devono contenere solo caratteri a-z, A-Z, 0-9 o trattini bassi con una lunghezza massima di 64. Esempio con 1 parametro obbligatorio e 1 facoltativo: tipo: proprietà OBJECT: param1: tipo: STRING param2: tipo: INTEGER obbligatorio:

  • param1

.google.cloud.vertexai.v1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Restituisce
Tipo Description
SchemaOrBuilder

getParserForType()

public Parser<FunctionDeclaration> getParserForType()
Restituisce
Tipo Description
Parser<FunctionDeclaration>
Sostituzioni

getSerializedSize()

public int getSerializedSize()
Restituisce
Tipo Description
int
Sostituzioni

hasParameters()

public boolean hasParameters()

Facoltativo. Descrive i parametri di questa funzione nel formato JSON Schema Object. Riflette l'oggetto parametro Open API 3.03. string Chiave: il nome del parametro. I nomi dei parametri sono sensibili alle maiuscole. Valore schema: lo schema che definisce il tipo utilizzato per il parametro. Per una funzione senza parametri, è possibile lasciarla non impostata. I nomi dei parametri devono iniziare con una lettera o un trattino basso e devono contenere solo caratteri a-z, A-Z, 0-9 o trattini bassi con una lunghezza massima di 64. Esempio con 1 parametro obbligatorio e 1 facoltativo: tipo: proprietà OBJECT: param1: tipo: STRING param2: tipo: INTEGER obbligatorio:

  • param1

.google.cloud.vertexai.v1.Schema parameters = 3 [(.google.api.field_behavior) = OPTIONAL];

Restituisce
Tipo Description
boolean

Indica se è impostato il campo dei parametri.

hashCode()

public int hashCode()
Restituisce
Tipo Description
int
Sostituzioni

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Restituisce
Tipo Description
FieldAccessorTable
Sostituzioni

isInitialized()

public final boolean isInitialized()
Restituisce
Tipo Description
boolean
Sostituzioni

newBuilderForType()

public FunctionDeclaration.Builder newBuilderForType()
Restituisce
Tipo Description
FunctionDeclaration.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FunctionDeclaration.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parametro
Nome Description
parent BuilderParent
Restituisce
Tipo Description
FunctionDeclaration.Builder
Sostituzioni

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parametro
Nome Description
unused UnusedPrivateParameter
Restituisce
Tipo Description
Object
Sostituzioni

toBuilder()

public FunctionDeclaration.Builder toBuilder()
Restituisce
Tipo Description
FunctionDeclaration.Builder

writeTo(output di CodedOutputStream)

public void writeTo(CodedOutputStream output)
Parametro
Nome Description
output CodedOutputStream
Sostituzioni
Eccezioni
Tipo Description
IOException