Class DocumentInfo.Builder (0.51.0)

public static final class DocumentInfo.Builder extends GeneratedMessageV3.Builder<DocumentInfo.Builder> implements DocumentInfoOrBuilder

Detailed document information associated with a user event.

Protobuf type google.cloud.discoveryengine.v1alpha.DocumentInfo

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DocumentInfo.Builder

Implements

DocumentInfoOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllPromotionIds(Iterable<String> values)

public DocumentInfo.Builder addAllPromotionIds(Iterable<String> values)

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 4;

Parameter
Name	Description
`values`	`Iterable<String>` The promotionIds to add.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

addPromotionIds(String value)

public DocumentInfo.Builder addPromotionIds(String value)

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 4;

Parameter
Name	Description
`value`	`String` The promotionIds to add.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

addPromotionIdsBytes(ByteString value)

public DocumentInfo.Builder addPromotionIdsBytes(ByteString value)

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 4;

Parameter
Name	Description
`value`	`ByteString` The bytes of the promotionIds to add.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DocumentInfo build()

Returns
Type	Description
`DocumentInfo`

buildPartial()

public DocumentInfo buildPartial()

Returns
Type	Description
`DocumentInfo`

clear()

public DocumentInfo.Builder clear()

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDocumentDescriptor()

public DocumentInfo.Builder clearDocumentDescriptor()

Returns
Type	Description
`DocumentInfo.Builder`

clearField(Descriptors.FieldDescriptor field)

public DocumentInfo.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearId()

public DocumentInfo.Builder clearId()

The Document resource ID.

string id = 1;

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

clearJoined()

public DocumentInfo.Builder clearJoined()

Output only. Whether the referenced Document can be found in the data store.

bool joined = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

clearName()

public DocumentInfo.Builder clearName()

The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

string name = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPromotionIds()

public DocumentInfo.Builder clearPromotionIds()

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 4;

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

clearQuantity()

public DocumentInfo.Builder clearQuantity()

Quantity of the Document associated with the user event. Defaults to 1.

For example, this field is 2 if two quantities of the same Document are involved in a add-to-cart event.

Required for events of the following event types:

add-to-cart
purchase

optional int32 quantity = 3;

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

clearUri()

public DocumentInfo.Builder clearUri()

The Document URI - only allowed for website data stores.

string uri = 6;

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

clone()

public DocumentInfo.Builder clone()

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public DocumentInfo getDefaultInstanceForType()

Returns
Type	Description
`DocumentInfo`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDocumentDescriptorCase()

public DocumentInfo.DocumentDescriptorCase getDocumentDescriptorCase()

Returns
Type	Description
`DocumentInfo.DocumentDescriptorCase`

getId()

public String getId()

The Document resource ID.

string id = 1;

Returns
Type	Description
`String`	The id.

getIdBytes()

public ByteString getIdBytes()

The Document resource ID.

string id = 1;

Returns
Type	Description
`ByteString`	The bytes for id.

getJoined()

public boolean getJoined()

Output only. Whether the referenced Document can be found in the data store.

bool joined = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	The joined.

getName()

public String getName()

The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

string name = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

string name = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for name.

getPromotionIds(int index)

public String getPromotionIds(int index)

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 4;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The promotionIds at the given index.

getPromotionIdsBytes(int index)

public ByteString getPromotionIdsBytes(int index)

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 4;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the promotionIds at the given index.

getPromotionIdsCount()

public int getPromotionIdsCount()

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 4;

Returns
Type	Description
`int`	The count of promotionIds.

getPromotionIdsList()

public ProtocolStringList getPromotionIdsList()

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 4;

Returns
Type	Description
`ProtocolStringList`	A list containing the promotionIds.

getQuantity()

public int getQuantity()

Quantity of the Document associated with the user event. Defaults to 1.

For example, this field is 2 if two quantities of the same Document are involved in a add-to-cart event.

Required for events of the following event types:

add-to-cart
purchase

optional int32 quantity = 3;

Returns
Type	Description
`int`	The quantity.

getUri()

public String getUri()

The Document URI - only allowed for website data stores.

string uri = 6;

Returns
Type	Description
`String`	The uri.

getUriBytes()

public ByteString getUriBytes()

The Document URI - only allowed for website data stores.

string uri = 6;

Returns
Type	Description
`ByteString`	The bytes for uri.

hasId()

public boolean hasId()

The Document resource ID.

string id = 1;

Returns
Type	Description
`boolean`	Whether the id field is set.

hasName()

public boolean hasName()

The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

string name = 2 [(.google.api.resource_reference) = { ... }

Returns
Type	Description
`boolean`	Whether the name field is set.

hasQuantity()

public boolean hasQuantity()

Quantity of the Document associated with the user event. Defaults to 1.

For example, this field is 2 if two quantities of the same Document are involved in a add-to-cart event.

Required for events of the following event types:

add-to-cart
purchase

optional int32 quantity = 3;

Returns
Type	Description
`boolean`	Whether the quantity field is set.

hasUri()

public boolean hasUri()

The Document URI - only allowed for website data stores.

string uri = 6;

Returns
Type	Description
`boolean`	Whether the uri field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(DocumentInfo other)

public DocumentInfo.Builder mergeFrom(DocumentInfo other)

Parameter
Name	Description
`other`	`DocumentInfo`

Returns
Type	Description
`DocumentInfo.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DocumentInfo.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setId(String value)

public DocumentInfo.Builder setId(String value)

The Document resource ID.

string id = 1;

Parameter
Name	Description
`value`	`String` The id to set.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

setIdBytes(ByteString value)

public DocumentInfo.Builder setIdBytes(ByteString value)

The Document resource ID.

string id = 1;

Parameter
Name	Description
`value`	`ByteString` The bytes for id to set.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

setJoined(boolean value)

public DocumentInfo.Builder setJoined(boolean value)

Output only. Whether the referenced Document can be found in the data store.

bool joined = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
`value`	`boolean` The joined to set.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

setName(String value)

public DocumentInfo.Builder setName(String value)

The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

string name = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public DocumentInfo.Builder setNameBytes(ByteString value)

The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

string name = 2 [(.google.api.resource_reference) = { ... }

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

setPromotionIds(int index, String value)

public DocumentInfo.Builder setPromotionIds(int index, String value)

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

repeated string promotion_ids = 4;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The promotionIds to set.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

setQuantity(int value)

public DocumentInfo.Builder setQuantity(int value)

Quantity of the Document associated with the user event. Defaults to 1.

For example, this field is 2 if two quantities of the same Document are involved in a add-to-cart event.

Required for events of the following event types:

add-to-cart
purchase

optional int32 quantity = 3;

Parameter
Name	Description
`value`	`int` The quantity to set.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DocumentInfo.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUri(String value)

public DocumentInfo.Builder setUri(String value)

The Document URI - only allowed for website data stores.

string uri = 6;

Parameter
Name	Description
`value`	`String` The uri to set.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.

setUriBytes(ByteString value)

public DocumentInfo.Builder setUriBytes(ByteString value)

The Document URI - only allowed for website data stores.

string uri = 6;

Parameter
Name	Description
`value`	`ByteString` The bytes for uri to set.

Returns
Type	Description
`DocumentInfo.Builder`	This builder for chaining.