Class ProcessedDocument.Builder (0.81.0)

public static final class ProcessedDocument.Builder extends GeneratedMessage.Builder<ProcessedDocument.Builder> implements ProcessedDocumentOrBuilder

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

Protobuf type google.cloud.discoveryengine.v1alpha.ProcessedDocument

Static Methods

getDescriptor()

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

Methods

build()

public ProcessedDocument build()
Returns
Type Description
ProcessedDocument

buildPartial()

public ProcessedDocument buildPartial()
Returns
Type Description
ProcessedDocument

clear()

public ProcessedDocument.Builder clear()
Returns
Type Description
ProcessedDocument.Builder
Overrides

clearDocument()

public ProcessedDocument.Builder clearDocument()

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
ProcessedDocument.Builder

This builder for chaining.

clearJsonData()

public ProcessedDocument.Builder clearJsonData()

The JSON string representation of the processed document.

string json_data = 2;

Returns
Type Description
ProcessedDocument.Builder

This builder for chaining.

clearProcessedDataFormat()

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

getDefaultInstanceForType()

public ProcessedDocument getDefaultInstanceForType()
Returns
Type Description
ProcessedDocument

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getProcessedDataFormatCase()

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ProcessedDocument other)

public ProcessedDocument.Builder mergeFrom(ProcessedDocument other)
Parameter
Name Description
other ProcessedDocument
Returns
Type Description
ProcessedDocument.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ProcessedDocument.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ProcessedDocument.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ProcessedDocument.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ProcessedDocument.Builder
Overrides

setDocument(String value)

public ProcessedDocument.Builder setDocument(String value)

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) = { ... }

Parameter
Name Description
value String

The document to set.

Returns
Type Description
ProcessedDocument.Builder

This builder for chaining.

setDocumentBytes(ByteString value)

public ProcessedDocument.Builder setDocumentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for document to set.

Returns
Type Description
ProcessedDocument.Builder

This builder for chaining.

setJsonData(String value)

public ProcessedDocument.Builder setJsonData(String value)

The JSON string representation of the processed document.

string json_data = 2;

Parameter
Name Description
value String

The jsonData to set.

Returns
Type Description
ProcessedDocument.Builder

This builder for chaining.

setJsonDataBytes(ByteString value)

public ProcessedDocument.Builder setJsonDataBytes(ByteString value)

The JSON string representation of the processed document.

string json_data = 2;

Parameter
Name Description
value ByteString

The bytes for jsonData to set.

Returns
Type Description
ProcessedDocument.Builder

This builder for chaining.