Class DocumentInfo.Builder
- java.lang.Object
-
- com.google.protobuf.AbstractMessageLite.Builder
-
- com.google.protobuf.AbstractMessage.Builder<BuilderT>
-
- com.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
- com.google.cloud.discoveryengine.v1.DocumentInfo.Builder
-
- All Implemented Interfaces:
DocumentInfoOrBuilder,com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Cloneable
- Enclosing class:
- DocumentInfo
public static final class DocumentInfo.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder> implements DocumentInfoOrBuilder
Detailed document information associated with a user event.
Protobuf typegoogle.cloud.discoveryengine.v1.DocumentInfo
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description DocumentInfo.BuilderaddAllPromotionIds(Iterable<String> values)The promotion IDs associated with this Document.DocumentInfo.BuilderaddPromotionIds(String value)The promotion IDs associated with this Document.DocumentInfo.BuilderaddPromotionIdsBytes(com.google.protobuf.ByteString value)The promotion IDs associated with this Document.DocumentInfo.BuilderaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)DocumentInfobuild()DocumentInfobuildPartial()DocumentInfo.Builderclear()DocumentInfo.BuilderclearDocumentDescriptor()DocumentInfo.BuilderclearField(com.google.protobuf.Descriptors.FieldDescriptor field)DocumentInfo.BuilderclearId()The [Document][google.cloud.discoveryengine.v1.Document] resource ID.DocumentInfo.BuilderclearName()The [Document][google.cloud.discoveryengine.v1.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}`DocumentInfo.BuilderclearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)DocumentInfo.BuilderclearPromotionIds()The promotion IDs associated with this Document.DocumentInfo.BuilderclearQuantity()Quantity of the Document associated with the user event.DocumentInfo.BuilderclearUri()The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.DocumentInfo.Builderclone()DocumentInfogetDefaultInstanceForType()static com.google.protobuf.Descriptors.DescriptorgetDescriptor()com.google.protobuf.Descriptors.DescriptorgetDescriptorForType()DocumentInfo.DocumentDescriptorCasegetDocumentDescriptorCase()StringgetId()The [Document][google.cloud.discoveryengine.v1.Document] resource ID.com.google.protobuf.ByteStringgetIdBytes()The [Document][google.cloud.discoveryengine.v1.Document] resource ID.StringgetName()The [Document][google.cloud.discoveryengine.v1.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}`com.google.protobuf.ByteStringgetNameBytes()The [Document][google.cloud.discoveryengine.v1.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}`StringgetPromotionIds(int index)The promotion IDs associated with this Document.com.google.protobuf.ByteStringgetPromotionIdsBytes(int index)The promotion IDs associated with this Document.intgetPromotionIdsCount()The promotion IDs associated with this Document.com.google.protobuf.ProtocolStringListgetPromotionIdsList()The promotion IDs associated with this Document.intgetQuantity()Quantity of the Document associated with the user event.StringgetUri()The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.com.google.protobuf.ByteStringgetUriBytes()The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.booleanhasId()The [Document][google.cloud.discoveryengine.v1.Document] resource ID.booleanhasName()The [Document][google.cloud.discoveryengine.v1.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}`booleanhasQuantity()Quantity of the Document associated with the user event.booleanhasUri()The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()booleanisInitialized()DocumentInfo.BuildermergeFrom(DocumentInfo other)DocumentInfo.BuildermergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)DocumentInfo.BuildermergeFrom(com.google.protobuf.Message other)DocumentInfo.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)DocumentInfo.BuildersetField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)DocumentInfo.BuildersetId(String value)The [Document][google.cloud.discoveryengine.v1.Document] resource ID.DocumentInfo.BuildersetIdBytes(com.google.protobuf.ByteString value)The [Document][google.cloud.discoveryengine.v1.Document] resource ID.DocumentInfo.BuildersetName(String value)The [Document][google.cloud.discoveryengine.v1.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}`DocumentInfo.BuildersetNameBytes(com.google.protobuf.ByteString value)The [Document][google.cloud.discoveryengine.v1.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}`DocumentInfo.BuildersetPromotionIds(int index, String value)The promotion IDs associated with this Document.DocumentInfo.BuildersetQuantity(int value)Quantity of the Document associated with the user event.DocumentInfo.BuildersetRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)DocumentInfo.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)DocumentInfo.BuildersetUri(String value)The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.DocumentInfo.BuildersetUriBytes(com.google.protobuf.ByteString value)The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.-
Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3
-
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
-
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Method Detail
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
clear
public DocumentInfo.Builder clear()
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
getDefaultInstanceForType
public DocumentInfo getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
public DocumentInfo build()
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public DocumentInfo buildPartial()
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
public DocumentInfo.Builder clone()
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
setField
public DocumentInfo.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
clearField
public DocumentInfo.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
clearOneof
public DocumentInfo.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
setRepeatedField
public DocumentInfo.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
addRepeatedField
public DocumentInfo.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
mergeFrom
public DocumentInfo.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<DocumentInfo.Builder>
-
mergeFrom
public DocumentInfo.Builder mergeFrom(DocumentInfo other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
mergeFrom
public DocumentInfo.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<DocumentInfo.Builder>- Throws:
IOException
-
getDocumentDescriptorCase
public DocumentInfo.DocumentDescriptorCase getDocumentDescriptorCase()
- Specified by:
getDocumentDescriptorCasein interfaceDocumentInfoOrBuilder
-
clearDocumentDescriptor
public DocumentInfo.Builder clearDocumentDescriptor()
-
hasId
public boolean hasId()
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
string id = 1;- Specified by:
hasIdin interfaceDocumentInfoOrBuilder- Returns:
- Whether the id field is set.
-
getId
public String getId()
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
string id = 1;- Specified by:
getIdin interfaceDocumentInfoOrBuilder- Returns:
- The id.
-
getIdBytes
public com.google.protobuf.ByteString getIdBytes()
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
string id = 1;- Specified by:
getIdBytesin interfaceDocumentInfoOrBuilder- Returns:
- The bytes for id.
-
setId
public DocumentInfo.Builder setId(String value)
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
string id = 1;- Parameters:
value- The id to set.- Returns:
- This builder for chaining.
-
clearId
public DocumentInfo.Builder clearId()
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
string id = 1;- Returns:
- This builder for chaining.
-
setIdBytes
public DocumentInfo.Builder setIdBytes(com.google.protobuf.ByteString value)
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
string id = 1;- Parameters:
value- The bytes for id to set.- Returns:
- This builder for chaining.
-
hasName
public boolean hasName()
The [Document][google.cloud.discoveryengine.v1.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) = { ... }- Specified by:
hasNamein interfaceDocumentInfoOrBuilder- Returns:
- Whether the name field is set.
-
getName
public String getName()
The [Document][google.cloud.discoveryengine.v1.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) = { ... }- Specified by:
getNamein interfaceDocumentInfoOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()
The [Document][google.cloud.discoveryengine.v1.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) = { ... }- Specified by:
getNameBytesin interfaceDocumentInfoOrBuilder- Returns:
- The bytes for name.
-
setName
public DocumentInfo.Builder setName(String value)
The [Document][google.cloud.discoveryengine.v1.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) = { ... }- Parameters:
value- The name to set.- Returns:
- This builder for chaining.
-
clearName
public DocumentInfo.Builder clearName()
The [Document][google.cloud.discoveryengine.v1.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:
- This builder for chaining.
-
setNameBytes
public DocumentInfo.Builder setNameBytes(com.google.protobuf.ByteString value)
The [Document][google.cloud.discoveryengine.v1.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) = { ... }- Parameters:
value- The bytes for name to set.- Returns:
- This builder for chaining.
-
hasUri
public boolean hasUri()
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.
string uri = 6;- Specified by:
hasUriin interfaceDocumentInfoOrBuilder- Returns:
- Whether the uri field is set.
-
getUri
public String getUri()
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.
string uri = 6;- Specified by:
getUriin interfaceDocumentInfoOrBuilder- Returns:
- The uri.
-
getUriBytes
public com.google.protobuf.ByteString getUriBytes()
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.
string uri = 6;- Specified by:
getUriBytesin interfaceDocumentInfoOrBuilder- Returns:
- The bytes for uri.
-
setUri
public DocumentInfo.Builder setUri(String value)
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.
string uri = 6;- Parameters:
value- The uri to set.- Returns:
- This builder for chaining.
-
clearUri
public DocumentInfo.Builder clearUri()
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.
string uri = 6;- Returns:
- This builder for chaining.
-
setUriBytes
public DocumentInfo.Builder setUriBytes(com.google.protobuf.ByteString value)
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.
string uri = 6;- Parameters:
value- The bytes for uri to set.- Returns:
- This builder for chaining.
-
hasQuantity
public boolean hasQuantity()
Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 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;- Specified by:
hasQuantityin interfaceDocumentInfoOrBuilder- Returns:
- Whether the quantity field is set.
-
getQuantity
public int getQuantity()
Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 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;- Specified by:
getQuantityin interfaceDocumentInfoOrBuilder- Returns:
- The quantity.
-
setQuantity
public DocumentInfo.Builder setQuantity(int value)
Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 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;- Parameters:
value- The quantity to set.- Returns:
- 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 will be 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:
- This builder for chaining.
-
getPromotionIdsList
public com.google.protobuf.ProtocolStringList getPromotionIdsList()
The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
repeated string promotion_ids = 4;- Specified by:
getPromotionIdsListin interfaceDocumentInfoOrBuilder- Returns:
- A list containing the promotionIds.
-
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;- Specified by:
getPromotionIdsCountin interfaceDocumentInfoOrBuilder- Returns:
- The count of promotionIds.
-
getPromotionIds
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;- Specified by:
getPromotionIdsin interfaceDocumentInfoOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The promotionIds at the given index.
-
getPromotionIdsBytes
public com.google.protobuf.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;- Specified by:
getPromotionIdsBytesin interfaceDocumentInfoOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the promotionIds at the given index.
-
setPromotionIds
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:
index- The index to set the value at.value- The promotionIds to set.- Returns:
- This builder for chaining.
-
addPromotionIds
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;- Parameters:
value- The promotionIds to add.- Returns:
- This builder for chaining.
-
addAllPromotionIds
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;- Parameters:
values- The promotionIds to add.- Returns:
- This builder for chaining.
-
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:
- This builder for chaining.
-
addPromotionIdsBytes
public DocumentInfo.Builder addPromotionIdsBytes(com.google.protobuf.ByteString value)
The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
repeated string promotion_ids = 4;- Parameters:
value- The bytes of the promotionIds to add.- Returns:
- This builder for chaining.
-
setUnknownFields
public final DocumentInfo.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
mergeUnknownFields
public final DocumentInfo.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
-