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.Builder
addAllPromotionIds(Iterable<String> values)
The promotion IDs associated with this Document.DocumentInfo.Builder
addPromotionIds(String value)
The promotion IDs associated with this Document.DocumentInfo.Builder
addPromotionIdsBytes(com.google.protobuf.ByteString value)
The promotion IDs associated with this Document.DocumentInfo.Builder
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
DocumentInfo
build()
DocumentInfo
buildPartial()
DocumentInfo.Builder
clear()
DocumentInfo.Builder
clearDocumentDescriptor()
DocumentInfo.Builder
clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
DocumentInfo.Builder
clearId()
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.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}`DocumentInfo.Builder
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
DocumentInfo.Builder
clearPromotionIds()
The promotion IDs associated with this Document.DocumentInfo.Builder
clearQuantity()
Quantity of the Document associated with the user event.DocumentInfo.Builder
clearUri()
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.DocumentInfo.Builder
clone()
DocumentInfo
getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor
getDescriptor()
com.google.protobuf.Descriptors.Descriptor
getDescriptorForType()
DocumentInfo.DocumentDescriptorCase
getDocumentDescriptorCase()
String
getId()
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.com.google.protobuf.ByteString
getIdBytes()
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.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}`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
getPromotionIds(int index)
The promotion IDs associated with this Document.com.google.protobuf.ByteString
getPromotionIdsBytes(int index)
The promotion IDs associated with this Document.int
getPromotionIdsCount()
The promotion IDs associated with this Document.com.google.protobuf.ProtocolStringList
getPromotionIdsList()
The promotion IDs associated with this Document.int
getQuantity()
Quantity of the Document associated with the user event.String
getUri()
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.com.google.protobuf.ByteString
getUriBytes()
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.boolean
hasId()
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.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}`boolean
hasQuantity()
Quantity of the Document associated with the user event.boolean
hasUri()
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
internalGetFieldAccessorTable()
boolean
isInitialized()
DocumentInfo.Builder
mergeFrom(DocumentInfo other)
DocumentInfo.Builder
mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
DocumentInfo.Builder
mergeFrom(com.google.protobuf.Message other)
DocumentInfo.Builder
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
DocumentInfo.Builder
setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
DocumentInfo.Builder
setId(String value)
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.DocumentInfo.Builder
setIdBytes(com.google.protobuf.ByteString value)
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.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}`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}`DocumentInfo.Builder
setPromotionIds(int index, String value)
The promotion IDs associated with this Document.DocumentInfo.Builder
setQuantity(int value)
Quantity of the Document associated with the user event.DocumentInfo.Builder
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
DocumentInfo.Builder
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
DocumentInfo.Builder
setUri(String value)
The [Document][google.cloud.discoveryengine.v1.Document] URI - only allowed for website data stores.DocumentInfo.Builder
setUriBytes(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:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
clear
public DocumentInfo.Builder clear()
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
getDefaultInstanceForType
public DocumentInfo getDefaultInstanceForType()
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
public DocumentInfo build()
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
public DocumentInfo buildPartial()
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
clone
public DocumentInfo.Builder clone()
- Specified by:
clone
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clone
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clone
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
setField
public DocumentInfo.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
setField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setField
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
clearField
public DocumentInfo.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
- Specified by:
clearField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearField
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
clearOneof
public DocumentInfo.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
- Specified by:
clearOneof
in interfacecom.google.protobuf.Message.Builder
- Overrides:
clearOneof
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
setRepeatedField
public DocumentInfo.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
- Specified by:
setRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
addRepeatedField
public DocumentInfo.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
- Specified by:
addRepeatedField
in interfacecom.google.protobuf.Message.Builder
- Overrides:
addRepeatedField
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
mergeFrom
public DocumentInfo.Builder mergeFrom(com.google.protobuf.Message other)
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<DocumentInfo.Builder>
-
mergeFrom
public DocumentInfo.Builder mergeFrom(DocumentInfo other)
-
isInitialized
public final boolean isInitialized()
- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in 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:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<DocumentInfo.Builder>
- Throws:
IOException
-
getDocumentDescriptorCase
public DocumentInfo.DocumentDescriptorCase getDocumentDescriptorCase()
- Specified by:
getDocumentDescriptorCase
in interfaceDocumentInfoOrBuilder
-
clearDocumentDescriptor
public DocumentInfo.Builder clearDocumentDescriptor()
-
hasId
public boolean hasId()
The [Document][google.cloud.discoveryengine.v1.Document] resource ID.
string id = 1;
- Specified by:
hasId
in 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:
getId
in 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:
getIdBytes
in 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:
hasName
in 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:
getName
in 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:
getNameBytes
in 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:
hasUri
in 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:
getUri
in 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:
getUriBytes
in 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:
hasQuantity
in 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:
getQuantity
in 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:
getPromotionIdsList
in 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:
getPromotionIdsCount
in 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:
getPromotionIds
in 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:
getPromotionIdsBytes
in 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:
setUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
setUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
mergeUnknownFields
public final DocumentInfo.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
- Specified by:
mergeUnknownFields
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeUnknownFields
in classcom.google.protobuf.GeneratedMessageV3.Builder<DocumentInfo.Builder>
-
-