com.google.cloud.aiplatform.v1

Interface FunctionDeclarationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

FunctionDeclaration, FunctionDeclaration.Builder

public interface FunctionDeclarationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getDescription() Optional.
com.google.protobuf.ByteString	getDescriptionBytes() Optional.
String	getName() Required.
com.google.protobuf.ByteString	getNameBytes() Required.
Schema	getParameters() Optional.
SchemaOrBuilder	getParametersOrBuilder() Optional.
boolean	hasParameters() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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 and dashes, with a maximum
 length of 64.
 

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

Returns:

The name.

getNameBytes

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 and dashes, with a maximum
 length of 64.
 

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

Returns:

The bytes for name.

getDescription

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];

Returns:

The description.

getDescriptionBytes

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];

Returns:

The bytes for description.

hasParameters

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. Example with 1 required and 1 optional
 parameter: type: OBJECT properties:
  param1:
    type: STRING
  param2:
    type: INTEGER
 required:
  - param1
 

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

Returns:

Whether the parameters field is set.

getParameters

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. Example with 1 required and 1 optional
 parameter: type: OBJECT properties:
  param1:
    type: STRING
  param2:
    type: INTEGER
 required:
  - param1
 

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

Returns:

The parameters.

getParametersOrBuilder

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. Example with 1 required and 1 optional
 parameter: type: OBJECT properties:
  param1:
    type: STRING
  param2:
    type: INTEGER
 required:
  - param1
 

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