Class ProcessedDocument (0.41.0)

public final class ProcessedDocument extends GeneratedMessageV3 implements ProcessedDocumentOrBuilder

Document captures all raw metadata information of items to be recommended or searched.

Protobuf type google.cloud.discoveryengine.v1alpha.ProcessedDocument

Static Fields

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int

JSON_DATA_FIELD_NUMBER

public static final int JSON_DATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ProcessedDocument getDefaultInstance()
Returns
Type Description
ProcessedDocument

getDescriptor()

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

newBuilder()

public static ProcessedDocument.Builder newBuilder()
Returns
Type Description
ProcessedDocument.Builder

newBuilder(ProcessedDocument prototype)

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

parseDelimitedFrom(InputStream input)

public static ProcessedDocument parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProcessedDocument
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static ProcessedDocument parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ProcessedDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static ProcessedDocument parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ProcessedDocument
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static ProcessedDocument parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ProcessedDocument
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static ProcessedDocument parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ProcessedDocument
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<ProcessedDocument> parser()
Returns
Type Description
Parser<ProcessedDocument>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ProcessedDocument getDefaultInstanceForType()
Returns
Type Description
ProcessedDocument

getDocument()

public String getDocument()

Required. Full resource name of the referenced document, in the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.

string document = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The document.

getDocumentBytes()

public ByteString getDocumentBytes()

Required. Full resource name of the referenced document, in the format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.

string document = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for document.

getJsonData()

public String getJsonData()

The JSON string representation of the processed document.

string json_data = 2;

Returns
Type Description
String

The jsonData.

getJsonDataBytes()

public ByteString getJsonDataBytes()

The JSON string representation of the processed document.

string json_data = 2;

Returns
Type Description
ByteString

The bytes for jsonData.

getParserForType()

public Parser<ProcessedDocument> getParserForType()
Returns
Type Description
Parser<ProcessedDocument>
Overrides

getProcessedDataFormatCase()

public ProcessedDocument.ProcessedDataFormatCase getProcessedDataFormatCase()
Returns
Type Description
ProcessedDocument.ProcessedDataFormatCase

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasJsonData()

public boolean hasJsonData()

The JSON string representation of the processed document.

string json_data = 2;

Returns
Type Description
boolean

Whether the jsonData 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 ProcessedDocument.Builder newBuilderForType()
Returns
Type Description
ProcessedDocument.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public ProcessedDocument.Builder toBuilder()
Returns
Type Description
ProcessedDocument.Builder

writeTo(CodedOutputStream output)

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