Class Document.Content.Builder (0.31.0)

public static final class Document.Content.Builder extends GeneratedMessageV3.Builder<Document.Content.Builder> implements Document.ContentOrBuilder

Unstructured data linked to this document.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Content.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Document.Content.Builder
Overrides

build()

public Document.Content build()
Returns
TypeDescription
Document.Content

buildPartial()

public Document.Content buildPartial()
Returns
TypeDescription
Document.Content

clear()

public Document.Content.Builder clear()
Returns
TypeDescription
Document.Content.Builder
Overrides

clearContent()

public Document.Content.Builder clearContent()
Returns
TypeDescription
Document.Content.Builder

clearField(Descriptors.FieldDescriptor field)

public Document.Content.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Document.Content.Builder
Overrides

clearMimeType()

public Document.Content.Builder clearMimeType()

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
TypeDescription
Document.Content.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Content.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Document.Content.Builder
Overrides

clearRawBytes()

public Document.Content.Builder clearRawBytes()

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
TypeDescription
Document.Content.Builder

This builder for chaining.

clearUri()

public Document.Content.Builder clearUri()

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
TypeDescription
Document.Content.Builder

This builder for chaining.

clone()

public Document.Content.Builder clone()
Returns
TypeDescription
Document.Content.Builder
Overrides

getContentCase()

public Document.Content.ContentCase getContentCase()
Returns
TypeDescription
Document.Content.ContentCase

getDefaultInstanceForType()

public Document.Content getDefaultInstanceForType()
Returns
TypeDescription
Document.Content

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for mimeType.

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
TypeDescription
ByteString

The rawBytes.

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the uri field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Document.Content other)

public Document.Content.Builder mergeFrom(Document.Content other)
Parameter
NameDescription
otherDocument.Content
Returns
TypeDescription
Document.Content.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Content.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Document.Content.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Document.Content.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Document.Content.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Content.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.Content.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Content.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Document.Content.Builder
Overrides

setMimeType(String value)

public Document.Content.Builder setMimeType(String value)

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;

Parameter
NameDescription
valueString

The mimeType to set.

Returns
TypeDescription
Document.Content.Builder

This builder for chaining.

setMimeTypeBytes(ByteString value)

public Document.Content.Builder setMimeTypeBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for mimeType to set.

Returns
TypeDescription
Document.Content.Builder

This builder for chaining.

setRawBytes(ByteString value)

public Document.Content.Builder setRawBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The rawBytes to set.

Returns
TypeDescription
Document.Content.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Document.Content.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Document.Content.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Content.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Document.Content.Builder
Overrides

setUri(String value)

public Document.Content.Builder setUri(String value)

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;

Parameter
NameDescription
valueString

The uri to set.

Returns
TypeDescription
Document.Content.Builder

This builder for chaining.

setUriBytes(ByteString value)

public Document.Content.Builder setUriBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for uri to set.

Returns
TypeDescription
Document.Content.Builder

This builder for chaining.