Class ProcessedDocument.Builder (0.44.0)

public static final class ProcessedDocument.Builder extends GeneratedMessageV3.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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ProcessedDocument.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ProcessedDocument.Builder
Overrides

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.

clearField(Descriptors.FieldDescriptor field)

public ProcessedDocument.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ProcessedDocument.Builder
Overrides

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.

clearOneof(Descriptors.OneofDescriptor oneof)

public ProcessedDocument.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ProcessedDocument.Builder
Overrides

clearProcessedDataFormat()

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

clone()

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

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ProcessedDocument.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
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.

setField(Descriptors.FieldDescriptor field, Object value)

public ProcessedDocument.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ProcessedDocument.Builder
Overrides

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.

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

public ProcessedDocument.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ProcessedDocument.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ProcessedDocument.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ProcessedDocument.Builder
Overrides