Class Document.Content (0.38.0) 

public static final class Document.Content extends GeneratedMessageV3 implements Document.ContentOrBuilder

Unstructured data linked to this document.

Protobuf type google.cloud.discoveryengine.v1.Document.Content

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document.Content

Static Fields

MIME_TYPE_FIELD_NUMBER

public static final int MIME_TYPE_FIELD_NUMBER
Field Value
Type Description
int

RAW_BYTES_FIELD_NUMBER

public static final int RAW_BYTES_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Document.Content getDefaultInstance()
Returns
Type Description
Document.Content

getDescriptor()

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

newBuilder()

public static Document.Content.Builder newBuilder()
Returns
Type Description
Document.Content.Builder

newBuilder(Document.Content prototype)

public static Document.Content.Builder newBuilder(Document.Content prototype)
Parameter
Name Description
prototype Document.Content
Returns
Type Description
Document.Content.Builder

parseDelimitedFrom(InputStream input)

public static Document.Content parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Content
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Content parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Content
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Document.Content parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Document.Content
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Content parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Content
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Content parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Document.Content
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Content parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Content
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Content parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Document.Content
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Content parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Content
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Document.Content parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Content
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Content parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Content
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Document.Content parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Document.Content
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Content parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Content
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Document.Content> parser()
Returns
Type Description
Parser<Content>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getContentCase()

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

getDefaultInstanceForType()

public Document.Content getDefaultInstanceForType()
Returns
Type Description
Document.Content

getMimeType()

public String getMimeType()

The MIME type of the content. Supported types:

  • application/pdf (PDF, only native PDFs are supported for now)
  • text/html (HTML)
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)
  • application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX)

  • text/plain (TXT)

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

string mime_type = 1;

Returns
Type Description
String

The mimeType.

getMimeTypeBytes()

public ByteString getMimeTypeBytes()

The MIME type of the content. Supported types:

  • application/pdf (PDF, only native PDFs are supported for now)
  • text/html (HTML)
  • application/vnd.openxmlformats-officedocument.wordprocessingml.document (DOCX)
  • application/vnd.openxmlformats-officedocument.presentationml.presentation (PPTX)

  • text/plain (TXT)

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

string mime_type = 1;

Returns
Type Description
ByteString

The bytes for mimeType.

getParserForType()

public Parser<Document.Content> getParserForType()
Returns
Type Description
Parser<Content>
Overrides

getRawBytes()

public 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUri()

public 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, 100 MB for other formats.

string uri = 3;

Returns
Type Description
String

The uri.

getUriBytes()

public 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, 100 MB for other formats.

string uri = 3;

Returns
Type Description
ByteString

The bytes for uri.

hasRawBytes()

public 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 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, 100 MB for other formats.

string uri = 3;

Returns
Type Description
boolean

Whether the uri field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Document.Content.Builder newBuilderForType()
Returns
Type Description
Document.Content.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Content.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.Content.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Document.Content.Builder toBuilder()
Returns
Type Description
Document.Content.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException