Package com.google.cloud.discoveryengine.v1alpha

Interface FileMetadataOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FileMetadata, FileMetadata.Builder
@Generated public interface FileMetadataOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getFileId

      String getFileId()
       Output only. The ID of the file.
      string file_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The fileId.

    • getFileIdBytes

      com.google.protobuf.ByteString getFileIdBytes()
       Output only. The ID of the file.
      string file_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for fileId.

    • getName

      String getName()
       Output only. The name of the file uploaded.
      string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Output only. The name of the file uploaded.
      string name = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for name.

    • getMimeType

      String getMimeType()
       The content type of the file, see
 https://www.iana.org/assignments/media-types/media-types.xhtml.
      string mime_type = 3;
      Returns:
      The mimeType.

    • getMimeTypeBytes

      com.google.protobuf.ByteString getMimeTypeBytes()
       The content type of the file, see
 https://www.iana.org/assignments/media-types/media-types.xhtml.
      string mime_type = 3;
      Returns:
      The bytes for mimeType.

    • getByteSize

      long getByteSize()
       Output only. The size of the context file in bytes.
      int64 byte_size = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The byteSize.

    • getOriginalUri

      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:
 1. If the file was sent as inline data (e.g. pasted from the clipboard).
 2. 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:
      The originalUri.

    • getOriginalUriBytes

      com.google.protobuf.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:
 1. If the file was sent as inline data (e.g. pasted from the clipboard).
 2. 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:
      The bytes for originalUri.

    • getOriginalSourceTypeValue

      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:
      The enum numeric value on the wire for originalSourceType.

    • getOriginalSourceType

      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:
      The originalSourceType.

    • hasUploadTime

      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:
      Whether the uploadTime field is set.

    • getUploadTime

      com.google.protobuf.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:
      The uploadTime.

    • getUploadTimeOrBuilder

      com.google.protobuf.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];

    • hasLastAddTime

      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:
      Whether the lastAddTime field is set.

    • getLastAddTime

      com.google.protobuf.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:
      The lastAddTime.

    • getLastAddTimeOrBuilder

      com.google.protobuf.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];

    • getMetadataCount

      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];

    • containsMetadata

      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];

    • getMetadata

      @Deprecated Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.

    • getMetadataMap

      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];

    • getMetadataOrDefault

      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];

    • getMetadataOrThrow

      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];

    • getDownloadUri

      String getDownloadUri()
       Output only. The
 [AssistantService.DownloadSessionFile][google.cloud.discoveryengine.v1alpha.AssistantService.DownloadSessionFile]
 URL to download the file. This URL will need the same credentials as
 [AssistantService.ListSessionFileMetadata][google.cloud.discoveryengine.v1alpha.AssistantService.ListSessionFileMetadata]
 method and will provide the resource.
      string download_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The downloadUri.

    • getDownloadUriBytes

      com.google.protobuf.ByteString getDownloadUriBytes()
       Output only. The
 [AssistantService.DownloadSessionFile][google.cloud.discoveryengine.v1alpha.AssistantService.DownloadSessionFile]
 URL to download the file. This URL will need the same credentials as
 [AssistantService.ListSessionFileMetadata][google.cloud.discoveryengine.v1alpha.AssistantService.ListSessionFileMetadata]
 method and will provide the resource.
      string download_uri = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for downloadUri.

    • getFileOriginTypeValue

      int getFileOriginTypeValue()
       Optional. The origin of the file.
      .google.cloud.discoveryengine.v1alpha.FileOriginType file_origin_type = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The enum numeric value on the wire for fileOriginType.

    • getFileOriginType

      FileOriginType getFileOriginType()
       Optional. The origin of the file.
      .google.cloud.discoveryengine.v1alpha.FileOriginType file_origin_type = 21 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The fileOriginType.

    • getViewsCount

      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];

    • containsViews

      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];

    • getViews

      @Deprecated Map<String,FileView> getViews()
      Deprecated.
      Use getViewsMap() instead.

    • getViewsMap

      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];

    • getViewsOrDefault

      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];

    • getViewsOrThrow

      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];