- 0.66.0 (latest)
- 0.64.0
- 0.63.0
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface FileMetadataOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
containsMetadata(String key)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
containsViews(String key)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getByteSize()
public abstract 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. |
getDownloadUri()
public abstract 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. |
getDownloadUriBytes()
public abstract 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. |
getFileId()
public abstract 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. |
getFileIdBytes()
public abstract 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. |
getFileOriginType()
public abstract FileOriginType getFileOriginType()Optional. The origin of the file.
.google.cloud.discoveryengine.v1alpha.FileOriginType file_origin_type = 21 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
FileOriginType |
The fileOriginType. |
getFileOriginTypeValue()
public abstract 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. |
getLastAddTime()
public abstract 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. |
getLastAddTimeOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getMetadata() (deprecated)
public abstract Map<String,String> getMetadata()Use #getMetadataMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMetadataCount()
public abstract 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 |
|
getMetadataMap()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getMetadataOrDefault(String key, String defaultValue)
public abstract 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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMetadataOrThrow(String key)
public abstract 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 |
|
getMimeType()
public abstract String getMimeType()The content type of the file, see https://www.iana.org/assignments/media-types/media-types.xhtml.
string mime_type = 3;
| Returns | |
|---|---|
| Type | Description |
String |
The mimeType. |
getMimeTypeBytes()
public abstract ByteString getMimeTypeBytes()The content type of the file, see https://www.iana.org/assignments/media-types/media-types.xhtml.
string mime_type = 3;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for mimeType. |
getName()
public abstract String getName()Output only. The name of the file uploaded.
string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract 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. |
getOriginalSourceType()
public abstract 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. |
getOriginalSourceTypeValue()
public abstract 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. |
getOriginalUri()
public abstract 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. |
getOriginalUriBytes()
public abstract 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. |
getUploadTime()
public abstract 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. |
getUploadTimeOrBuilder()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getViews() (deprecated)
public abstract Map<String,FileView> getViews()Use #getViewsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,FileView> |
|
getViewsCount()
public abstract 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 |
|
getViewsMap()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
Map<String,FileView> |
|
getViewsOrDefault(String key, FileView defaultValue)
public abstract 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];
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
FileView |
| Returns | |
|---|---|
| Type | Description |
FileView |
|
getViewsOrThrow(String key)
public abstract 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 |
| Returns | |
|---|---|
| Type | Description |
FileView |
|
hasLastAddTime()
public abstract 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. |
hasUploadTime()
public abstract 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. |