Interface Document.ContentOrBuilder (0.72.0) 

public static interface Document.ContentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContentCase()

public abstract Document.Content.ContentCase getContentCase()
Returns
Type Description
Document.Content.ContentCase

getMimeType()

public abstract String getMimeType()

The MIME type of the content. Supported types:

  • application/pdf (PDF, only native PDFs are supported for now)
  • text/html (HTML)
  • text/plain (TXT)
  • application/xml or text/xml (XML)
  • application/json (JSON)
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)
  • application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX)
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX)

  • application/vnd.ms-excel.sheet.macroenabled.12 (XLSM)

    The following types are supported only if layout parser is enabled in the data store:

  • image/bmp (BMP)

  • image/gif (GIF)
  • image/jpeg (JPEG)
  • image/png (PNG)

  • image/tiff (TIFF)

    See https://www.iana.org/assignments/media-types/media-types.xhtml.

string mime_type = 1;

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public abstract ByteString getMimeTypeBytes()

The MIME type of the content. Supported types:

  • application/pdf (PDF, only native PDFs are supported for now)
  • text/html (HTML)
  • text/plain (TXT)
  • application/xml or text/xml (XML)
  • application/json (JSON)
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)
  • application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX)
  • application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (XLSX)

  • application/vnd.ms-excel.sheet.macroenabled.12 (XLSM)

    The following types are supported only if layout parser is enabled in the data store:

  • image/bmp (BMP)

  • image/gif (GIF)
  • image/jpeg (JPEG)
  • image/png (PNG)

  • image/tiff (TIFF)

    See https://www.iana.org/assignments/media-types/media-types.xhtml.

string mime_type = 1;

Returns
Type Description
ByteString

The bytes for mimeType.

getRawBytes()

public abstract ByteString getRawBytes()

The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB).

Note: As with all bytes fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, abc123!?$*&()'-=@~ should be represented as YWJjMTIzIT8kKiYoKSctPUB+ in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.

bytes raw_bytes = 2;

Returns
Type Description
ByteString

The rawBytes.

getUri()

public abstract String getUri()

The URI of the content. Only Cloud Storage URIs (e.g. gs://bucket-name/path/to/file) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats.

string uri = 3;

Returns
Type Description
String

The uri.

getUriBytes()

public abstract ByteString getUriBytes()

The URI of the content. Only Cloud Storage URIs (e.g. gs://bucket-name/path/to/file) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats.

string uri = 3;

Returns
Type Description
ByteString

The bytes for uri.

hasRawBytes()

public abstract boolean hasRawBytes()

The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB).

Note: As with all bytes fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, abc123!?$*&()'-=@~ should be represented as YWJjMTIzIT8kKiYoKSctPUB+ in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.

bytes raw_bytes = 2;

Returns
Type Description
boolean

Whether the rawBytes field is set.

hasUri()

public abstract boolean hasUri()

The URI of the content. Only Cloud Storage URIs (e.g. gs://bucket-name/path/to/file) are supported. The maximum file size is 2.5 MB for text-based formats, 200 MB for other formats.

string uri = 3;

Returns
Type Description
boolean

Whether the uri field is set.