Class FunctionResponseFileData.Builder (1.43.0)

public static final class FunctionResponseFileData.Builder extends GeneratedMessage.Builder<FunctionResponseFileData.Builder> implements FunctionResponseFileDataOrBuilder

URI based data for function response.

Protobuf type google.cloud.vertexai.v1.FunctionResponseFileData

Static Methods

getDescriptor()

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

Methods

build()

public FunctionResponseFileData build()
Returns
Type Description
FunctionResponseFileData

buildPartial()

public FunctionResponseFileData buildPartial()
Returns
Type Description
FunctionResponseFileData

clear()

public FunctionResponseFileData.Builder clear()
Returns
Type Description
FunctionResponseFileData.Builder
Overrides

clearDisplayName()

public FunctionResponseFileData.Builder clearDisplayName()

Optional. Display name of the file data.

Used to provide a label or filename to distinguish file datas.

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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FunctionResponseFileData.Builder

This builder for chaining.

clearFileUri()

public FunctionResponseFileData.Builder clearFileUri()

Required. URI.

string file_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
FunctionResponseFileData.Builder

This builder for chaining.

clearMimeType()

public FunctionResponseFileData.Builder clearMimeType()

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

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

Returns
Type Description
FunctionResponseFileData.Builder

This builder for chaining.

getDefaultInstanceForType()

public FunctionResponseFileData getDefaultInstanceForType()
Returns
Type Description
FunctionResponseFileData

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

Optional. Display name of the file data.

Used to provide a label or filename to distinguish file datas.

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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Optional. Display name of the file data.

Used to provide a label or filename to distinguish file datas.

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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for displayName.

getFileUri()

public String getFileUri()

Required. URI.

string file_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The fileUri.

getFileUriBytes()

public ByteString getFileUriBytes()

Required. URI.

string file_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for fileUri.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FunctionResponseFileData other)

public FunctionResponseFileData.Builder mergeFrom(FunctionResponseFileData other)
Parameter
Name Description
other FunctionResponseFileData
Returns
Type Description
FunctionResponseFileData.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FunctionResponseFileData.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunctionResponseFileData.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FunctionResponseFileData.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FunctionResponseFileData.Builder
Overrides

setDisplayName(String value)

public FunctionResponseFileData.Builder setDisplayName(String value)

Optional. Display name of the file data.

Used to provide a label or filename to distinguish file datas.

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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The displayName to set.

Returns
Type Description
FunctionResponseFileData.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public FunctionResponseFileData.Builder setDisplayNameBytes(ByteString value)

Optional. Display name of the file data.

Used to provide a label or filename to distinguish file datas.

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 = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for displayName to set.

Returns
Type Description
FunctionResponseFileData.Builder

This builder for chaining.

setFileUri(String value)

public FunctionResponseFileData.Builder setFileUri(String value)

Required. URI.

string file_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value String

The fileUri to set.

Returns
Type Description
FunctionResponseFileData.Builder

This builder for chaining.

setFileUriBytes(ByteString value)

public FunctionResponseFileData.Builder setFileUriBytes(ByteString value)

Required. URI.

string file_uri = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value ByteString

The bytes for fileUri to set.

Returns
Type Description
FunctionResponseFileData.Builder

This builder for chaining.

setMimeType(String value)

public FunctionResponseFileData.Builder setMimeType(String value)

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

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

Parameter
Name Description
value String

The mimeType to set.

Returns
Type Description
FunctionResponseFileData.Builder

This builder for chaining.

setMimeTypeBytes(ByteString value)

public FunctionResponseFileData.Builder setMimeTypeBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for mimeType to set.

Returns
Type Description
FunctionResponseFileData.Builder

This builder for chaining.