- 0.49.0 (latest)
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public static final class DocumentInfo.Builder extends GeneratedMessageV3.Builder<DocumentInfo.Builder> implements DocumentInfoOrBuilderDetailed document information associated with a user event.
Protobuf type google.cloud.discoveryengine.v1beta.DocumentInfo
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > DocumentInfo.BuilderImplements
DocumentInfoOrBuilderStatic 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 | StringThe 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 | ByteStringThe 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 | |
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 | |
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 | |
clearId()
public DocumentInfo.Builder clearId()The Document resource ID.
string id = 1;
| 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 | |
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 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-cartpurchase
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 | |
getDefaultInstanceForType()
public DocumentInfo getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
DocumentInfo | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
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 | intThe 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 | intThe 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 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-cartpurchase
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 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-cartpurchase
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 | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
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 | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public DocumentInfo.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
DocumentInfo.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final DocumentInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DocumentInfo.Builder | |
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 | |
setId(String value)
public DocumentInfo.Builder setId(String value)The Document resource ID.
string id = 1;
| Parameter | |
|---|---|
| Name | Description |
value | StringThe 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 | ByteStringThe bytes for id 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 | StringThe 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 | ByteStringThe 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 | intThe index to set the value at. |
value | StringThe 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 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-cartpurchase
optional int32 quantity = 3;
| Parameter | |
|---|---|
| Name | Description |
value | intThe 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 | |
setUnknownFields(UnknownFieldSet unknownFields)
public final DocumentInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
DocumentInfo.Builder | |
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 | StringThe 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 | ByteStringThe bytes for uri to set. |
| Returns | |
|---|---|
| Type | Description |
DocumentInfo.Builder | This builder for chaining. |