public final class FileMetadata extends GeneratedMessageV3 implements FileMetadataOrBuilder
Represents a file attached to a session (context file)
Protobuf type google.cloud.discoveryengine.v1alpha.FileMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int BYTE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int DOWNLOAD_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FILE_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int FILE_ORIGIN_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LAST_ADD_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int METADATA_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MIME_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ORIGINAL_SOURCE_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int ORIGINAL_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int UPLOAD_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int VIEWS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static FileMetadata getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static FileMetadata.Builder newBuilder()
public static FileMetadata.Builder newBuilder(FileMetadata prototype)
public static FileMetadata parseDelimitedFrom(InputStream input)
public static FileMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FileMetadata parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static FileMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FileMetadata parseFrom(ByteString data)
public static FileMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FileMetadata parseFrom(CodedInputStream input)
public static FileMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FileMetadata parseFrom(InputStream input)
public static FileMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static FileMetadata parseFrom(ByteBuffer data)
public static FileMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<FileMetadata> parser()
Methods
public boolean containsMetadata(String key)
Optional. Represents metadata related to the file that can suit particular
use cases. The prefix "google." is reserved for the key for use by
Google, but other prefixes can be freely used.
map<string, string> metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
public boolean containsViews(String key)
Output only. Alternate views of this file object. Each file view is
attached to a specific role. Possible example keys:
- "thumbnail"
- "mobile_thumbnail"
- "clip"
- "summary"
- "translation"
map<string, .google.cloud.discoveryengine.v1alpha.FileView> views = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
key |
String
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
public long getByteSize()
Output only. The size of the context file in bytes.
int64 byte_size = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
long |
The byteSize.
|
public FileMetadata getDefaultInstanceForType()
public String getDownloadUri()
Output only. The
AssistantService.DownloadSessionFile
URL to download the file. This URL will need the same credentials as
AssistantService.ListSessionFileMetadata
method and will provide the resource.
string download_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The downloadUri.
|
public ByteString getDownloadUriBytes()
Output only. The
AssistantService.DownloadSessionFile
URL to download the file. This URL will need the same credentials as
AssistantService.ListSessionFileMetadata
method and will provide the resource.
string download_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for downloadUri.
|
public String getFileId()
Output only. The ID of the file.
string file_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The fileId.
|
public ByteString getFileIdBytes()
Output only. The ID of the file.
string file_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for fileId.
|
public FileOriginType getFileOriginType()
Optional. The origin of the file.
.google.cloud.discoveryengine.v1alpha.FileOriginType file_origin_type = 21 [(.google.api.field_behavior) = OPTIONAL];
public int getFileOriginTypeValue()
Optional. The origin of the file.
.google.cloud.discoveryengine.v1alpha.FileOriginType file_origin_type = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for fileOriginType.
|
public Timestamp getLastAddTime()
Output only. The time the file was added to the session. Note that if a
file was added, then modified externally, then added again, the add time
will be updated.
.google.protobuf.Timestamp last_add_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The lastAddTime.
|
public TimestampOrBuilder getLastAddTimeOrBuilder()
Output only. The time the file was added to the session. Note that if a
file was added, then modified externally, then added again, the add time
will be updated.
.google.protobuf.Timestamp last_add_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Map<String,String> getMetadata()
public int getMetadataCount()
Optional. Represents metadata related to the file that can suit particular
use cases. The prefix "google." is reserved for the key for use by
Google, but other prefixes can be freely used.
map<string, string> metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
|
public Map<String,String> getMetadataMap()
Optional. Represents metadata related to the file that can suit particular
use cases. The prefix "google." is reserved for the key for use by
Google, but other prefixes can be freely used.
map<string, string> metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
public String getMetadataOrDefault(String key, String defaultValue)
Optional. Represents metadata related to the file that can suit particular
use cases. The prefix "google." is reserved for the key for use by
Google, but other prefixes can be freely used.
map<string, string> metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
|
public String getMetadataOrThrow(String key)
Optional. Represents metadata related to the file that can suit particular
use cases. The prefix "google." is reserved for the key for use by
Google, but other prefixes can be freely used.
map<string, string> metadata = 18 [(.google.api.field_behavior) = OPTIONAL];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
public String getMimeType()
| Returns |
| Type |
Description |
String |
The mimeType.
|
public ByteString getMimeTypeBytes()
| Returns |
| Type |
Description |
ByteString |
The bytes for mimeType.
|
Output only. The name of the file uploaded.
string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
String |
The name.
|
public ByteString getNameBytes()
Output only. The name of the file uploaded.
string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
public FileSource getOriginalSourceType()
Optional. The type of the original source of the file.
.google.cloud.discoveryengine.v1alpha.FileSource original_source_type = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
FileSource |
The originalSourceType.
|
public int getOriginalSourceTypeValue()
Optional. The type of the original source of the file.
.google.cloud.discoveryengine.v1alpha.FileSource original_source_type = 10 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for originalSourceType.
|
public String getOriginalUri()
Optional. The original location of the file. It may be a local file path,
or any other URI that allows accessing the file in an external system.
There are two scenarios in which this url may be empty:
- If the file was sent as inline data (e.g. pasted from the clipboard).
If the original location is not available.
Note that there's no guarantee that the URI will be pointing to a valid
or actually existing file. For example, a file might have been uploaded
to the session, and then deleted from the original source.
string original_uri = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The originalUri.
|
public ByteString getOriginalUriBytes()
Optional. The original location of the file. It may be a local file path,
or any other URI that allows accessing the file in an external system.
There are two scenarios in which this url may be empty:
- If the file was sent as inline data (e.g. pasted from the clipboard).
If the original location is not available.
Note that there's no guarantee that the URI will be pointing to a valid
or actually existing file. For example, a file might have been uploaded
to the session, and then deleted from the original source.
string original_uri = 9 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for originalUri.
|
public Parser<FileMetadata> getParserForType()
Overrides
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
public Timestamp getUploadTime()
Output only. The time the file was uploaded (If this is a file
generated by an internal process and then made available to the session,
this indicates the moment it happened).
.google.protobuf.Timestamp upload_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The uploadTime.
|
public TimestampOrBuilder getUploadTimeOrBuilder()
Output only. The time the file was uploaded (If this is a file
generated by an internal process and then made available to the session,
this indicates the moment it happened).
.google.protobuf.Timestamp upload_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
public Map<String,FileView> getViews()
public int getViewsCount()
Output only. Alternate views of this file object. Each file view is
attached to a specific role. Possible example keys:
- "thumbnail"
- "mobile_thumbnail"
- "clip"
- "summary"
- "translation"
map<string, .google.cloud.discoveryengine.v1alpha.FileView> views = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
int |
|
public Map<String,FileView> getViewsMap()
Output only. Alternate views of this file object. Each file view is
attached to a specific role. Possible example keys:
- "thumbnail"
- "mobile_thumbnail"
- "clip"
- "summary"
- "translation"
map<string, .google.cloud.discoveryengine.v1alpha.FileView> views = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
public FileView getViewsOrDefault(String key, FileView defaultValue)
Output only. Alternate views of this file object. Each file view is
attached to a specific role. Possible example keys:
- "thumbnail"
- "mobile_thumbnail"
- "clip"
- "summary"
- "translation"
map<string, .google.cloud.discoveryengine.v1alpha.FileView> views = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
public FileView getViewsOrThrow(String key)
Output only. Alternate views of this file object. Each file view is
attached to a specific role. Possible example keys:
- "thumbnail"
- "mobile_thumbnail"
- "clip"
- "summary"
- "translation"
map<string, .google.cloud.discoveryengine.v1alpha.FileView> views = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter |
| Name |
Description |
key |
String
|
public boolean hasLastAddTime()
Output only. The time the file was added to the session. Note that if a
file was added, then modified externally, then added again, the add time
will be updated.
.google.protobuf.Timestamp last_add_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the lastAddTime field is set.
|
public boolean hasUploadTime()
Output only. The time the file was uploaded (If this is a file
generated by an internal process and then made available to the session,
this indicates the moment it happened).
.google.protobuf.Timestamp upload_time = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
boolean |
Whether the uploadTime field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public FileMetadata.Builder newBuilderForType()
protected FileMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public FileMetadata.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
