Class FunctionResponseBlob (3.79.0)

public final class FunctionResponseBlob extends GeneratedMessageV3 implements FunctionResponseBlobOrBuilder

Raw media bytes for function response.

Text should not be sent as raw bytes, use the 'text' field.

Protobuf type google.cloud.aiplatform.v1.FunctionResponseBlob

Static Fields

DATA_FIELD_NUMBER

public static final int DATA_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FunctionResponseBlob getDefaultInstance()
Returns
Type Description
FunctionResponseBlob

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FunctionResponseBlob.Builder newBuilder()
Returns
Type Description
FunctionResponseBlob.Builder

newBuilder(FunctionResponseBlob prototype)

public static FunctionResponseBlob.Builder newBuilder(FunctionResponseBlob prototype)
Parameter
Name Description
prototype FunctionResponseBlob
Returns
Type Description
FunctionResponseBlob.Builder

parseDelimitedFrom(InputStream input)

public static FunctionResponseBlob parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionResponseBlob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FunctionResponseBlob parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FunctionResponseBlob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FunctionResponseBlob parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FunctionResponseBlob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FunctionResponseBlob parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionResponseBlob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FunctionResponseBlob parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FunctionResponseBlob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FunctionResponseBlob parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FunctionResponseBlob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunctionResponseBlob
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FunctionResponseBlob> parser()
Returns
Type Description
Parser<FunctionResponseBlob>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getData()

public ByteString getData()

Required. Raw bytes.

bytes data = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The data.

getDefaultInstanceForType()

public FunctionResponseBlob getDefaultInstanceForType()
Returns
Type Description
FunctionResponseBlob

getDisplayName()

public String getDisplayName()

Optional. Display name of the blob.

Used to provide a label or filename to distinguish blobs.

This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name of the blob.

Used to provide a label or filename to distinguish blobs.

This field is only returned in PromptMessage for prompt management. It is currently used in the Gemini GenerateContent calls only when server side tools (code_execution, google_search, and url_context) are enabled.

string display_name = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getMimeType()

public String getMimeType()

Required. The IANA standard MIME type of the source data.

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

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

Required. The IANA standard MIME type of the source data.

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

Returns
Type Description
ByteString

The bytes for mimeType.

getParserForType()

public Parser<FunctionResponseBlob> getParserForType()
Returns
Type Description
Parser<FunctionResponseBlob>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FunctionResponseBlob.Builder newBuilderForType()
Returns
Type Description
FunctionResponseBlob.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FunctionResponseBlob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FunctionResponseBlob.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FunctionResponseBlob.Builder toBuilder()
Returns
Type Description
FunctionResponseBlob.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException