Package com.google.cloud.aiplatform.v1

Class FunctionResponse

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.FunctionResponse
All Implemented Interfaces:
FunctionResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class FunctionResponse extends com.google.protobuf.GeneratedMessage implements FunctionResponseOrBuilder
 The result output from a [FunctionCall] that contains a string representing
 the [FunctionDeclaration.name] and a structured JSON object containing any
 output from the function is used as context to the model. This should contain
 the result of a [FunctionCall] made based on model prediction.
Protobuf type google.cloud.aiplatform.v1.FunctionResponse
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FunctionResponse.Builder
    The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model.

    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
    NAME_FIELD_NUMBER
     
    static final int
    PARTS_FIELD_NUMBER
     
    static final int
    RESPONSE_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)
     
    static FunctionResponse
    getDefaultInstance()
     
    FunctionResponse
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    com.google.protobuf.Parser<FunctionResponse>
    getParserForType()
     
    FunctionResponsePart
    getParts(int index)
    Optional.
    int
    getPartsCount()
    Optional.
    List<FunctionResponsePart>
    getPartsList()
    Optional.
    FunctionResponsePartOrBuilder
    getPartsOrBuilder(int index)
    Optional.
    List<? extends FunctionResponsePartOrBuilder>
    getPartsOrBuilderList()
    Optional.
    com.google.protobuf.Struct
    getResponse()
    Required.
    com.google.protobuf.StructOrBuilder
    getResponseOrBuilder()
    Required.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    boolean
    hasResponse()
    Required.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FunctionResponse.Builder
    newBuilder()
     
    static FunctionResponse.Builder
    newBuilder(FunctionResponse prototype)
     
    FunctionResponse.Builder
    newBuilderForType()
     
    protected FunctionResponse.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static FunctionResponse
    parseDelimitedFrom(InputStream input)
     
    static FunctionResponse
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionResponse
    parseFrom(byte[] data)
     
    static FunctionResponse
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionResponse
    parseFrom(com.google.protobuf.ByteString data)
     
    static FunctionResponse
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionResponse
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FunctionResponse
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionResponse
    parseFrom(InputStream input)
     
    static FunctionResponse
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FunctionResponse
    parseFrom(ByteBuffer data)
     
    static FunctionResponse
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FunctionResponse>
    parser()
     
    FunctionResponse.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()
       Required. The name of the function to call.
 Matches [FunctionDeclaration.name] and [FunctionCall.name].
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface FunctionResponseOrBuilder
      Returns:
      The name.

    • getNameBytes

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

    • hasResponse

      public boolean hasResponse()
       Required. The function response in JSON object format.
 Use "output" key to specify function output and "error" key to specify
 error details (if any). If "output" and "error" keys are not specified,
 then whole "response" is treated as function output.
      .google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      hasResponse in interface FunctionResponseOrBuilder
      Returns:
      Whether the response field is set.

    • getResponse

      public com.google.protobuf.Struct getResponse()
       Required. The function response in JSON object format.
 Use "output" key to specify function output and "error" key to specify
 error details (if any). If "output" and "error" keys are not specified,
 then whole "response" is treated as function output.
      .google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getResponse in interface FunctionResponseOrBuilder
      Returns:
      The response.

    • getResponseOrBuilder

      public com.google.protobuf.StructOrBuilder getResponseOrBuilder()
       Required. The function response in JSON object format.
 Use "output" key to specify function output and "error" key to specify
 error details (if any). If "output" and "error" keys are not specified,
 then whole "response" is treated as function output.
      .google.protobuf.Struct response = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getResponseOrBuilder in interface FunctionResponseOrBuilder

    • getPartsList

      public List<FunctionResponsePart> getPartsList()
       Optional. Ordered `Parts` that constitute a function response. Parts may
 have different IANA MIME types.
      repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPartsList in interface FunctionResponseOrBuilder

    • getPartsOrBuilderList

      public List<? extends FunctionResponsePartOrBuilder> getPartsOrBuilderList()
       Optional. Ordered `Parts` that constitute a function response. Parts may
 have different IANA MIME types.
      repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPartsOrBuilderList in interface FunctionResponseOrBuilder

    • getPartsCount

      public int getPartsCount()
       Optional. Ordered `Parts` that constitute a function response. Parts may
 have different IANA MIME types.
      repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPartsCount in interface FunctionResponseOrBuilder

    • getParts

      public FunctionResponsePart getParts(int index)
       Optional. Ordered `Parts` that constitute a function response. Parts may
 have different IANA MIME types.
      repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getParts in interface FunctionResponseOrBuilder

    • getPartsOrBuilder

      public FunctionResponsePartOrBuilder getPartsOrBuilder(int index)
       Optional. Ordered `Parts` that constitute a function response. Parts may
 have different IANA MIME types.
      repeated .google.cloud.aiplatform.v1.FunctionResponsePart parts = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getPartsOrBuilder in interface FunctionResponseOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static FunctionResponse.Builder newBuilder()

    • newBuilder

      public static FunctionResponse.Builder newBuilder(FunctionResponse prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static FunctionResponse getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<FunctionResponse> 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 FunctionResponse getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder