Package com.google.cloud.aiplatform.v1

Class FunctionCall

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.FunctionCall
All Implemented Interfaces:
FunctionCallOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class FunctionCall extends com.google.protobuf.GeneratedMessage implements FunctionCallOrBuilder
 A predicted [FunctionCall] returned from the model that contains a string
 representing the [FunctionDeclaration.name] and a structured JSON object
 containing the parameters and their values.
Protobuf type google.cloud.aiplatform.v1.FunctionCall
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FunctionCall.Builder
    A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ARGS_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    PARTIAL_ARGS_FIELD_NUMBER
     
    static final int
    WILL_CONTINUE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    com.google.protobuf.Struct
    getArgs()
    Optional.
    com.google.protobuf.StructOrBuilder
    getArgsOrBuilder()
    Optional.
    static FunctionCall
    getDefaultInstance()
     
    FunctionCall
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    Optional.
    com.google.protobuf.ByteString
    getNameBytes()
    Optional.
    com.google.protobuf.Parser<FunctionCall>
    getParserForType()
     
    PartialArg
    getPartialArgs(int index)
    Optional.
    int
    getPartialArgsCount()
    Optional.
    List<PartialArg>
    getPartialArgsList()
    Optional.
    PartialArgOrBuilder
    getPartialArgsOrBuilder(int index)
    Optional.
    List<? extends PartialArgOrBuilder>
    getPartialArgsOrBuilderList()
    Optional.
    int
    getSerializedSize()
     
    boolean
    getWillContinue()
    Optional.
    boolean
    hasArgs()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FunctionCall.Builder
    newBuilder()
     
    static FunctionCall.Builder
    newBuilder(FunctionCall prototype)
     
    FunctionCall.Builder
    newBuilderForType()
     
    protected FunctionCall.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static FunctionCall
    parseDelimitedFrom(InputStream input)
     
    static FunctionCall
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionCall
    parseFrom(byte[] data)
     
    static FunctionCall
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionCall
    parseFrom(com.google.protobuf.ByteString data)
     
    static FunctionCall
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionCall
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FunctionCall
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionCall
    parseFrom(InputStream input)
     
    static FunctionCall
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionCall
    parseFrom(ByteBuffer data)
     
    static FunctionCall
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FunctionCall>
    parser()
     
    FunctionCall.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getName

      public String getName()
       Optional. The name of the function to call.
 Matches [FunctionDeclaration.name].
      string name = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getName in interface FunctionCallOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Optional. The name of the function to call.
 Matches [FunctionDeclaration.name].
      string name = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getNameBytes in interface FunctionCallOrBuilder
      Returns:
      The bytes for name.

    • hasArgs

      public boolean hasArgs()
       Optional. The function parameters and values in JSON object format.
 See [FunctionDeclaration.parameters] for parameter details.
      .google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasArgs in interface FunctionCallOrBuilder
      Returns:
      Whether the args field is set.

    • getArgs

      public com.google.protobuf.Struct getArgs()
       Optional. The function parameters and values in JSON object format.
 See [FunctionDeclaration.parameters] for parameter details.
      .google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArgs in interface FunctionCallOrBuilder
      Returns:
      The args.

    • getArgsOrBuilder

      public com.google.protobuf.StructOrBuilder getArgsOrBuilder()
       Optional. The function parameters and values in JSON object format.
 See [FunctionDeclaration.parameters] for parameter details.
      .google.protobuf.Struct args = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getArgsOrBuilder in interface FunctionCallOrBuilder

    • getPartialArgsList

      public List<PartialArg> getPartialArgsList()
       Optional. The partial argument value of the function call.
 If provided, represents the arguments/fields that are streamed
 incrementally.
      repeated .google.cloud.aiplatform.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPartialArgsList in interface FunctionCallOrBuilder

    • getPartialArgsOrBuilderList

      public List<? extends PartialArgOrBuilder> getPartialArgsOrBuilderList()
       Optional. The partial argument value of the function call.
 If provided, represents the arguments/fields that are streamed
 incrementally.
      repeated .google.cloud.aiplatform.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPartialArgsOrBuilderList in interface FunctionCallOrBuilder

    • getPartialArgsCount

      public int getPartialArgsCount()
       Optional. The partial argument value of the function call.
 If provided, represents the arguments/fields that are streamed
 incrementally.
      repeated .google.cloud.aiplatform.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPartialArgsCount in interface FunctionCallOrBuilder

    • getPartialArgs

      public PartialArg getPartialArgs(int index)
       Optional. The partial argument value of the function call.
 If provided, represents the arguments/fields that are streamed
 incrementally.
      repeated .google.cloud.aiplatform.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPartialArgs in interface FunctionCallOrBuilder

    • getPartialArgsOrBuilder

      public PartialArgOrBuilder getPartialArgsOrBuilder(int index)
       Optional. The partial argument value of the function call.
 If provided, represents the arguments/fields that are streamed
 incrementally.
      repeated .google.cloud.aiplatform.v1.PartialArg partial_args = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPartialArgsOrBuilder in interface FunctionCallOrBuilder

    • getWillContinue

      public boolean getWillContinue()
       Optional. Whether this is the last part of the FunctionCall.
 If true, another partial message for the current FunctionCall is expected
 to follow.
      bool will_continue = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getWillContinue in interface FunctionCallOrBuilder
      Returns:
      The willContinue.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • 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 FunctionCall parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static FunctionCall parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static FunctionCall parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static FunctionCall parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static FunctionCall parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static FunctionCall parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

      public FunctionCall.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static FunctionCall.Builder newBuilder()

    • newBuilder

      public static FunctionCall.Builder newBuilder(FunctionCall prototype)

    • toBuilder

      public FunctionCall.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected FunctionCall.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static FunctionCall getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FunctionCall> 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.GeneratedMessage

    • getDefaultInstanceForType

      public FunctionCall getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder